concourse / concourse/concourse-chart

Instructions for secrets are incorrect

Open
#370 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Describe the bug

In the documentation the section on manually creating secrets has an error.

For secrets like OIDC, postgres, (the ones I tested) you are instructed to create a secret [release-name]-concourse. However, at install time the Deploy resource expects secret keys in [release-name]-web. E.g. postgresql-user, oidc-client-id, etc.

Reproduction steps

Create a secret my-release-concourse with fields postgresql-user and postgresql-password and install the release configuring to BYO your own postgres. You will see that the deployment pod and init container give an error that they could not find the secret.

Expected behavior

Either the documentation should be updated, or the templates should reflect the documentation. Either way is fine for me.

It would probably even be better to be able to configure the names of the secrets for the various inputs. As its pretty confusing to get this right anyhow and you have to jump through hoops to get them with the right name.

Additional context

No response

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 locating the documentation section for manually creating secrets and the Helm templates that reference the release-specific secret names. Compare the documented [release-name]-concourse name with the [release-name]-web name used by the Deploy resource; done means the instructions and chart behavior agree, or the supported configuration is clearly documented.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.