Skip to content

Commit

Permalink
chores: update installation requirements in docs (#467)
Browse files Browse the repository at this point in the history
  • Loading branch information
yetone committed May 10, 2023
1 parent e643b2a commit 4d8bc76
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 4 additions & 0 deletions docs/source/installation/yatai.rst
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
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
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

0 comments on commit 4d8bc76

Please sign in to comment.