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

fix(helm): Removed duplicate bucketNames from documentation and fixed key name deploymentMode #12641

Merged
merged 7 commits into from
Apr 18, 2024

Conversation

ddaskal
Copy link
Contributor

@ddaskal ddaskal commented Apr 16, 2024

What this PR does / why we need it:
Fixes documentation for Helm deployments to not have duplicate values and utilize correct deploymentMode key name.

Which issue(s) this PR fixes:
Fixes #12610

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
  • 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

@ddaskal ddaskal requested a review from a team as a code owner April 16, 2024 20:13
@CLAassistant
Copy link

CLAassistant commented Apr 16, 2024

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Apr 16, 2024
@JStickler
Copy link
Contributor

@ddaskal Please note this item in the PR checklist and update the other files, and sign the contributor license agreement.
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

@ddaskal ddaskal changed the title remove duplicate bucketNames documentation helm: remove duplicate bucketNames documentation Apr 16, 2024
@ddaskal ddaskal changed the title helm: remove duplicate bucketNames documentation helm: Remove duplicate bucketNames documentation Apr 16, 2024
@ddaskal ddaskal changed the title helm: Remove duplicate bucketNames documentation helm: Removed duplicate bucketNames from documentation and fixed key name deploymentMode Apr 16, 2024
@ddaskal
Copy link
Contributor Author

ddaskal commented Apr 16, 2024

@JStickler I believe this is ready for review again. Do I need to squash my commits first or are you able to do a squash & merge?

@JStickler
Copy link
Contributor

@ddaskal No need to squash, we squash and merge. I've already tagged someone who works on the Helm charts to review this (I'm the technical writer on the team, so I only approve doc updates and leave the code changes to the engineering team).

@JStickler JStickler changed the title helm: Removed duplicate bucketNames from documentation and fixed key name deploymentMode fix (helm): Removed duplicate bucketNames from documentation and fixed key name deploymentMode Apr 17, 2024
@JStickler JStickler changed the title fix (helm): Removed duplicate bucketNames from documentation and fixed key name deploymentMode fix(helm): Removed duplicate bucketNames from documentation and fixed key name deploymentMode Apr 17, 2024
Copy link
Contributor

@MichelHollands MichelHollands left a comment

Choose a reason for hiding this comment

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

LGTM

@MichelHollands MichelHollands merged commit 0d8ff9e into grafana:main Apr 18, 2024
15 checks passed
@ddaskal ddaskal deleted the patch-1 branch April 18, 2024 15:19
@grafanabot
Copy link
Collaborator

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-12641-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 0d8ff9ee7929b8facbdb469abe344c320d3bd5ce

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-12641-to-release-3.0.x
# Create the PR body template
PR_BODY=$(gh pr view 12641 --json body --template 'Backport 0d8ff9ee7929b8facbdb469abe344c320d3bd5ce from #12641{{ "\n\n---\n\n" }}{{ index . "body" }}')
# Create the PR on GitHub
echo "${PR_BODY}" | gh pr create --title 'chore: [release-3.0.x] fix(helm): Removed duplicate bucketNames from documentation and fixed key name `deploymentMode`' --body-file - --label 'size/S' --label 'area/helm' --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-12641-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-12641-to-release-3.0.x`.

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

mraboosk pushed a commit to mraboosk/loki that referenced this pull request Oct 7, 2024
… key name `deploymentMode` (grafana#12641)

Co-authored-by: Michel Hollands <42814411+MichelHollands@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/helm backport release-3.0.x backport-failed size/S 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.

Can't install Loki using the monolithic Helm chart from documentation
5 participants