Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chores: update installation requirements in docs #467

Merged
merged 1 commit into from
May 10, 2023
Merged

chores: update installation requirements in docs #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/source/installation/yatai.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Prerequisites

If you do not have a production Kubernetes cluster and want to install yatai for development and testing purposes. You can use `minikube <https://minikube.sigs.k8s.io/docs/start/>`_ to set up a local Kubernetes cluster for testing. If you are using macOS, you should use `hyperkit <https://minikube.sigs.k8s.io/docs/drivers/hyperkit/>`_ driver to prevent the macOS docker desktop `network limitation <https://docs.docker.com/desktop/networking/#i-cannot-ping-my-containers>`_

- Dynamic Volume Provisioning

If you use MinIO as the object storage, you need to enable dynamic volume provisioning in your Kubernetes cluster. See `Dynamic Volume Provisioning <https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/>`_ for more details.

- Helm

Yatai uses `Helm <https://helm.sh/docs/intro/using_helm/>`_ to install yatai.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/observability/logs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Because the metrics collected are related to BentotDeployment, it relies on yata

If you do not have a production Kubernetes cluster and want to install yatai for development and testing purposes. You can use `minikube <https://minikube.sigs.k8s.io/docs/start/>`_ to set up a local Kubernetes cluster for testing.

- Default StorageClass
- Dynamic Volume Provisioning

A default `StorageClass <https://kubernetes.io/docs/concepts/storage/storage-classes/>`_ is required for Loki to store logs.
As Loki requires log storage, you need to enable dynamic volume provisioning in your Kubernetes cluster. For more detailed information, please refer to `Dynamic Volume Provisioning <https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/>`_.

- Helm

Expand Down
4 changes: 2 additions & 2 deletions docs/source/observability/metrics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Because the metrics collected are related to BentotDeployment, it relies on yata

If you do not have a production Kubernetes cluster and want to install yatai for development and testing purposes. You can use `minikube <https://minikube.sigs.k8s.io/docs/start/>`_ to set up a local Kubernetes cluster for testing.

- Default StorageClass
- Dynamic Volume Provisioning

A default `StorageClass <https://kubernetes.io/docs/concepts/storage/storage-classes/>`_ is required for the Prometheus server to store metrics data.
As Prometheus requires metrics storage, you need to enable dynamic volume provisioning in your Kubernetes cluster. For more detailed information, please refer to `Dynamic Volume Provisioning <https://kubernetes.io/docs/concepts/storage/dynamic-provisioning/>`_.

- Helm

Expand Down