Skip to content

Tiny clarification on environment variables in README.md #25

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.

Sign up for GitHub

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

Open
neilmb wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Tiny clarification on environment variables in README.md #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ You can also supply:
- `cf_api:` to specify a Cloud Foundry API endpoint (instead of the default `api.fr.cloud.gov`)
- `cf_manifest:` to use a different manifest file (instead of the default `manifest.yml`)
- `cf_vars_file:` to [specify values for variables in the manifest file](https://docs.cloudfoundry.org/devguide/deploy-apps/manifest-attributes.html#variable-substitution)
- `cf_command:` to specify a CF sub-command to run (instead of the default `push -f $MANIFEST -vars-file $VARS_FILE --strategy rolling`)
- `cf_command:` to specify a CF sub-command to run (instead of the default `push -f $cf_manifest -vars-file $cf_vars_file --strategy rolling`)
Copy link
Contributor

@markdboyd markdboyd Jul 23, 2024

Choose a reason for hiding this comment

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

Suggested change
- `cf_command:` to specify a CF sub-command to run (instead of the default `push -f $cf_manifest -vars-file $cf_vars_file --strategy rolling`)
- `cf_command:` to specify a CF sub-command to run (instead of the default `push -f $MANIFEST --strategy rolling`)

So the default command does not include a vars file: https://github.com/cloud-gov/cg-cli-tools/blob/main/entrypoint.sh#L38

And $MANIFEST is the variable that is used, which will respect the value of cf_manifest if set, otherwise it will default to manifest.yml:

https://github.com/cloud-gov/cg-cli-tools/blob/main/entrypoint.sh#L30

- `command:` to specify another command altogether (for example: a script which checks if required services are present and creates them if they're missing)

## A note on versions
Expand Down