concourse / concourse/concourse-chart

Readme/post-install warning feedback

Open
#106 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
160
Forks
189
PR merge metrics
No merged PRs in 30d

Description

We successfully installed concourse on a GKE cluster today.

Install warning feedback:

The post-install baggage claim driver feedback is useful, but the values.yml is so big that it's hard to track down the parent keys so that you can actually set it. (i.e. concourse.worker.baggageclaim.driver). That configuration value is not listed in the README page, which it probably should be if there's going to be a post-install warning about it. The key should probably be printed in the warning message to make it easy on users.

We also got this warning:

"You're using the default "test" user with the default "test" password."

I think this is spurious in our case, because we also set secrets.create: false. However we did find the code in the chart that was printing this, and realized we could set secrets.localUsers: "" to make the warning go away. I did confirm that test:test does not work on our helm deployed concourse.

README feedback

I found that the README section about secrets was inaccurate with respect to creating secrets for local users, github secrets, and the postgres username/password. The README indicates that you put these in the $HELM_RELEASE-concourse secret, but we found that we had to put them into the $HELM_RELEASE-web secret.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the chart README, values.yml, and the templates or entry points that emit the post-install warnings. Verify the documented secret names and configuration paths against the chart behavior, including secrets.create and secrets.localUsers. Done means the README and warning guidance accurately describe the required keys and avoid misleading default-user warnings.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.