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.

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

docs: Added Simple Scalable Deployment guide for AWS #14327

Closed
wants to merge 29 commits into from

Conversation

Jayclifford345
Copy link
Contributor

This PR adds a guide to deploying the official Loki helm to AWS in Simple Scalable. It is worth noting that there are lot of AWS specific commands within this guide. This is hard to escape due to the nature of how Loki is deployed to AWS. I have added cavitates throughout the guide to help reduce the support burden on AWS-specific questions.

I am open to removing these sections but feel the guide would be insufficient for a user attempting to deploy Loki on AWS.

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@Jayclifford345 Jayclifford345 requested a review from a team as a code owner October 1, 2024 09:41
@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Oct 1, 2024
Copy link
Contributor

@tomglenn tomglenn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome work @Jayclifford345 ! 🎉
Left some comments and suggestions. 😄

docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@trevorwhitney trevorwhitney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great Jay! Just a few small comments.

docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
```bash
aws s3api create-bucket --bucket loki-aws-bucket --region eu-west-2 --create-bucket-configuration LocationConstraint=eu-west-2
```
Make sure to replace the region and bucket name with your desired values. We will revisit the bucket policy later in this guide.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and reiterating, making sure the values used in this doc are claimed by Grafana Labs

docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
Copy link
Contributor

@poyzannur poyzannur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great work Jay, thanks a lot!
Minor comments to clarify examples.

docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
```bash
aws s3api create-bucket --bucket loki-aws-bucket --region eu-west-2 --create-bucket-configuration LocationConstraint=eu-west-2
```
Make sure to replace the region and bucket name with your desired values. We will revisit the bucket policy later in this guide.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 I added a suggestion above.

docs/sources/setup/install/helm/install-scalable/aws.md Outdated Show resolved Hide resolved
@Jayclifford345
Copy link
Contributor Author

Hey @tomglenn, @poyzannur, @trevorwhitney thank you ever so much for the technical reviews. That should be all of your suggestions added. I shall let @JStickler give it the full docs review next and see where we are at. Then I can start filming the video

Copy link
Contributor

@moxious moxious left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great PR. Some minor things found but overall a massive improvement/contribution to what's there

@jenshor
Copy link
Contributor

jenshor commented Oct 11, 2024

Great improvement on the docs. Once I found this PR, I was quickly able to deploy Loki in SimpleScalable mode 👍🏻

@Jayclifford345
Copy link
Contributor Author

Hi all, after an internal discussion I am closing this PR and opened this one instead #14517 . This was after an internal discussion that we felt it was better to focus the deployment guide on distributed (microservice) and Monolithic deployments of the Loki helm. Let me know what you think of the changes in the other PR if you get chance!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XXL type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants