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: Deploy Loki Helm on AWS guide #14517

Merged
merged 61 commits into from
Oct 30, 2024
Merged

docs: Deploy Loki Helm on AWS guide #14517

merged 61 commits into from
Oct 30, 2024

Conversation

Jayclifford345
Copy link
Contributor

@Jayclifford345 Jayclifford345 commented Oct 17, 2024

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

  • 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 and others added 30 commits October 1, 2024 10:36
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] As always, I spotted a few more small things. =)

@Jayclifford345
Copy link
Contributor Author

Hi @JStickler,
So just a couple of notes:

  1. We leave the object storage type as s3 even when using MinIO since it is S3-compatible storage.
  2. I added a section to around creating authentication for Canary I didn't notice that this also requires authentication when you use a username and password for Loki.

Other than that I belive I manged to batch add ;) all of the other fixes. Ready for your review again

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

{docs team] LGTM

@JStickler JStickler merged commit 4e4d4a9 into main Oct 30, 2024
60 checks passed
@JStickler JStickler deleted the aws-helm-distributed branch October 30, 2024 12:41
@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Oct 30, 2024

The backport to release-3.1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14517-to-release-3.1.x origin/release-3.1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 4e4d4a962e9d1486b456693a4e951641e3ec6b3a

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-14517-to-release-3.1.x
# Create the PR body template
PR_BODY=$(gh pr view 14517 --json body --template 'Backport 4e4d4a962e9d1486b456693a4e951641e3ec6b3a from #14517{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Deploy Loki Helm on AWS guide (backport release-3.1.x)' --body-file - --label 'size/XXL' --label 'type/docs' --label 'backport' --base release-3.1.x --milestone release-3.1.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-14517-to-release-3.1.x

# Create a pull request where the `base` branch is `release-3.1.x` and the `compare`/`head` branch is `backport-14517-to-release-3.1.x`.

# Remove the local backport branch
git switch main
git branch -D backport-14517-to-release-3.1.x

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Oct 30, 2024

The backport to release-3.2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14517-to-release-3.2.x origin/release-3.2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 4e4d4a962e9d1486b456693a4e951641e3ec6b3a

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-14517-to-release-3.2.x
# Create the PR body template
PR_BODY=$(gh pr view 14517 --json body --template 'Backport 4e4d4a962e9d1486b456693a4e951641e3ec6b3a from #14517{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Deploy Loki Helm on AWS guide (backport release-3.2.x)' --body-file - --label 'size/XXL' --label 'type/docs' --label 'backport' --base release-3.2.x --milestone release-3.2.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-14517-to-release-3.2.x

# Create a pull request where the `base` branch is `release-3.2.x` and the `compare`/`head` branch is `backport-14517-to-release-3.2.x`.

# Remove the local backport branch
git switch main
git branch -D backport-14517-to-release-3.2.x

@loki-gh-app
Copy link
Contributor

loki-gh-app bot commented Oct 30, 2024

The backport to release-3.0.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new branch
git switch --create backport-14517-to-release-3.0.x origin/release-3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x 4e4d4a962e9d1486b456693a4e951641e3ec6b3a

When the conflicts are resolved, stage and commit the changes:

git add . && git cherry-pick --continue

If you have the GitHub CLI installed:

# Push the branch to GitHub:
git push --set-upstream origin backport-14517-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 14517 --json body --template 'Backport 4e4d4a962e9d1486b456693a4e951641e3ec6b3a from #14517{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'docs: Deploy Loki Helm on AWS guide (backport release-3.0.x)' --body-file - --label 'size/XXL' --label 'type/docs' --label 'backport' --base release-3.0.x --milestone release-3.0.x --web

Or, if you don't have the GitHub CLI installed (we recommend you install it!):

# Push the branch to GitHub:
git push --set-upstream origin backport-14517-to-release-3.0.x

# Create a pull request where the `base` branch is `release-3.0.x` and the `compare`/`head` branch is `backport-14517-to-release-3.0.x`.

# Remove the local backport branch
git switch main
git branch -D backport-14517-to-release-3.0.x

JStickler pushed a commit to JStickler/loki that referenced this pull request Oct 30, 2024
Co-authored-by: Tom Glenn <[email protected]>
Co-authored-by: Poyzan <[email protected]>
Co-authored-by: Jens Horstmann <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 4e4d4a9)
JStickler pushed a commit to JStickler/loki that referenced this pull request Oct 30, 2024
Co-authored-by: Tom Glenn <[email protected]>
Co-authored-by: Poyzan <[email protected]>
Co-authored-by: Jens Horstmann <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 4e4d4a9)
JStickler pushed a commit to JStickler/loki that referenced this pull request Oct 30, 2024
Co-authored-by: Tom Glenn <[email protected]>
Co-authored-by: Poyzan <[email protected]>
Co-authored-by: Jens Horstmann <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 4e4d4a9)
JStickler added a commit that referenced this pull request Oct 30, 2024
JStickler added a commit that referenced this pull request Oct 30, 2024
JStickler added a commit that referenced this pull request Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x backport-failed 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.

2 participants