docs: Deploy Loki Helm on AWS guide #14517
Open
+1,258
−311
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Tom Glenn <289945+tomglenn@users.noreply.github.com>
Co-authored-by: Tom Glenn <289945+tomglenn@users.noreply.github.com>
Co-authored-by: Tom Glenn <289945+tomglenn@users.noreply.github.com>
Co-authored-by: Tom Glenn <289945+tomglenn@users.noreply.github.com>
Co-authored-by: Tom Glenn <289945+tomglenn@users.noreply.github.com>
Co-authored-by: Tom Glenn <289945+tomglenn@users.noreply.github.com>
Co-authored-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: Jens Horstmann <jens@widgetbook.io>
github-actions
bot
added
the
type/docs
Jayclifford345
changed the title
7 tasks
Jayclifford345
changed the title
JStickler
reviewed
Oct 21, 2024
docs/sources/setup/install/helm/install-microservices/_index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
|
Ready for another run :) |
JStickler
reviewed
Oct 24, 2024
| @@ -167,59 +173,69 @@ It is not recommended to run microservice mode with `filesystem` storage. For th | |||
|
|
|||
| ## Object Storage Configuration | |||
|
|
|||
| After testing Loki with MinIO, it is recommended to configure Loki with an object storage provider. The following examples shows how to configure Loki with different object storage providers: | |||
| After testing Loki with [MinIO](https://min.io/docs/minio/kubernetes/upstream/index.html), we recommend to configure Loki with an object storage provider. The following examples shows how to configure Loki with different object storage providers: | |||
There was a problem hiding this comment.
Suggested change
| After testing Loki with [MinIO](https://min.io/docs/minio/kubernetes/upstream/index.html), we recommend to configure Loki with an object storage provider. The following examples shows how to configure Loki with different object storage providers: | |
| After testing Loki with [MinIO](https://min.io/docs/minio/kubernetes/upstream/index.html), we recommend configuring Loki with an object storage provider. The following examples shows how to configure Loki with different object storage providers: |
Comment on lines
+217
to
+219
| chunks: <Your AWS bucket for chunk eg. `aws-loki-dev-chunk`> | ||
| ruler: <Your AWS bucket for ruler eg. `aws-loki-dev-ruler`> | ||
| admin: <Your AWS bucket for admin eg. `aws-loki-dev-admin`> |
There was a problem hiding this comment.
Suggested change
| chunks: <Your AWS bucket for chunk eg. `aws-loki-dev-chunk`> | |
| ruler: <Your AWS bucket for ruler eg. `aws-loki-dev-ruler`> | |
| admin: <Your AWS bucket for admin eg. `aws-loki-dev-admin`> | |
| chunks: <Your AWS bucket for chunk, for example, `aws-loki-dev-chunk`> | |
| ruler: <Your AWS bucket for ruler , for example, `aws-loki-dev-ruler`> | |
| admin: <Your AWS bucket for admin , for example, `aws-loki-dev-admin`> |
| ruler: <Your AWS bucket for ruler eg. `aws-loki-dev-ruler`> | ||
| admin: <Your AWS bucket for admin eg. `aws-loki-dev-admin`> | ||
| s3: | ||
| # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name this works well for S3 compatible storages or are hosting Loki on-premises and want to use S3 as the storage backend. Either use the s3 URL or the individual fields below (AWS endpoint, region, secret). |
There was a problem hiding this comment.
Suggested change
| # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name this works well for S3 compatible storages or are hosting Loki on-premises and want to use S3 as the storage backend. Either use the s3 URL or the individual fields below (AWS endpoint, region, secret). | |
| # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name this works well for S3 compatible storage or if you are hosting Loki on-premises and want to use S3 as the storage backend. Either use the s3 URL or the individual fields below (AWS endpoint, region, secret). |
| We are actively working on providing more guides for deploying Loki in production. | ||
| {{< /admonition >}} | ||
|
|
||
| It is recommended to run Loki at scale within a cloud environment like AWS, Azure, or GCP. The below guides will show you how to deploy a minimally viable production environment. |
There was a problem hiding this comment.
Suggested change
| It is recommended to run Loki at scale within a cloud environment like AWS, Azure, or GCP. The below guides will show you how to deploy a minimally viable production environment. | |
| We recommend running Loki at scale within a cloud environment like AWS, Azure, or GCP. The below guides will show you how to deploy a minimally viable production environment. |
| 1. **Single Replica**: Run Loki with a single replica. This mode is useful for testing and development or if you are planning to run Loki as a meta-monitoring system. | ||
| 2. **Multiple Replicas**: Run Loki with multiple replicas. This mode is useful for high availability. This mode is less economical than microservice mode, but it is simpler to operate. We recommend running at least three replicas for high availability. | ||
|
|
||
| Once you have selected how many replicas you would like to deploy choose the appropriate `values.yaml` configuration file below and then continue with the deployment steps. |
There was a problem hiding this comment.
Suggested change
| Once you have selected how many replicas you would like to deploy choose the appropriate `values.yaml` configuration file below and then continue with the deployment steps. | |
| Once you have selected how many replicas you would like to deploy, choose the appropriate `values.yaml` configuration file below and then continue with the deployment steps. |
| s3: | ||
| # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name | ||
| # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name this works well for S3 compatible storages or are hosting Loki on-premises and want to use S3 as the storage backend. Either use the s3 URL or the individual fields below (AWS endpoint, region, secret). |
There was a problem hiding this comment.
Suggested change
| # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name this works well for S3 compatible storages or are hosting Loki on-premises and want to use S3 as the storage backend. Either use the s3 URL or the individual fields below (AWS endpoint, region, secret). | |
| # s3 URL can be used to specify the endpoint, access key, secret key, and bucket name this works well for S3 compatible storages or if you are hosting Loki on-premises and want to use S3 as the storage backend. Either use the s3 URL or the individual fields below (AWS endpoint, region, secret). |
| {{< /admonition >}} | ||
|
|
||
| ```bash | ||
| aws s3api create-bucket --bucket < YOUR CHUNK BUCKET NAME eg. `loki-aws-dev-chunks`> --region <S3 region your account is on, eg `eu-west-2`> --create-bucket-configuration LocationConstraint=<S3 region your account is on, eg `eu-west-2`> \ |
There was a problem hiding this comment.
Suggested change
| aws s3api create-bucket --bucket < YOUR CHUNK BUCKET NAME eg. `loki-aws-dev-chunks`> --region <S3 region your account is on, eg `eu-west-2`> --create-bucket-configuration LocationConstraint=<S3 region your account is on, eg `eu-west-2`> \ | |
| aws s3api create-bucket --bucket <YOUR CHUNK BUCKET NAME e.g. `loki-aws-dev-chunks`> --region <S3 region your account is on, e.g. `eu-west-2`> --create-bucket-configuration LocationConstraint=<S3 region your account is on, e.g. `eu-west-2`> \ |
|
|
||
| ```bash | ||
| aws s3api create-bucket --bucket < YOUR CHUNK BUCKET NAME eg. `loki-aws-dev-chunks`> --region <S3 region your account is on, eg `eu-west-2`> --create-bucket-configuration LocationConstraint=<S3 region your account is on, eg `eu-west-2`> \ | ||
| aws s3api create-bucket --bucket <YOUR RULER BUCKET NAME eg. `loki-aws-dev-ruler`> --region <S3 REGION your account is on, eg `eu-west-2`> --create-bucket-configuration LocationConstraint=<S3 REGION your account is on, eg `eu-west-2`> |
There was a problem hiding this comment.
Suggested change
| aws s3api create-bucket --bucket <YOUR RULER BUCKET NAME eg. `loki-aws-dev-ruler`> --region <S3 REGION your account is on, eg `eu-west-2`> --create-bucket-configuration LocationConstraint=<S3 REGION your account is on, eg `eu-west-2`> | |
| aws s3api create-bucket --bucket <YOUR RULER BUCKET NAME e.g. `loki-aws-dev-ruler`> --region <S3 REGION your account is on, e.g. `eu-west-2`> --create-bucket-configuration LocationConstraint=<S3 REGION your account is on, e.g. `eu-west-2`> |
| loki: | ||
| schemaConfig: | ||
| configs: | ||
| - from: 2024-04-01 |
There was a problem hiding this comment.
Suggested change
| - from: 2024-04-01 | |
| - from: "2024-04-01" |
|
|
||
| ### Loki Helm chart configuration | ||
|
|
||
| Create a `values.yaml` file choosing the configuration options that best suit your requirements. Below there are two examples of `values.yaml` files for the Loki Helm chart. The first template is Loki in [microservices](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#microservices-mode) mode the second is Loki in [monolithic](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#monolithic-mode) mode with a replication factor of 3. The rest of this guide will focus on deploying Loki in microservices mode. However, there is no difference in the deployment process between the two modes apart from the components you are deploying. |
There was a problem hiding this comment.
Suggested change
| Create a `values.yaml` file choosing the configuration options that best suit your requirements. Below there are two examples of `values.yaml` files for the Loki Helm chart. The first template is Loki in [microservices](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#microservices-mode) mode the second is Loki in [monolithic](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#monolithic-mode) mode with a replication factor of 3. The rest of this guide will focus on deploying Loki in microservices mode. However, there is no difference in the deployment process between the two modes apart from the components you are deploying. | |
| Create a `values.yaml` file choosing the configuration options that best suit your requirements. Below there is an example of `values.yaml` files for the Loki Helm chart in [microservices](https://grafana.com/docs/loki/<LOKI_VERSION>/get-started/deployment-modes/#microservices-mode) mode. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the successor PR to the SSD PR #14327
After an internal discussion, it was decided to focus deployment guides for helm on either Monolithic or microservice . The Loki team felt more comfortable supporting both of these deployment styles since its closer to what we deploy internally.
This PR is part of a large redesign to improve the helm documentation of Loki.
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PRdeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR