@govuk-pay/cli 0.0.61 → 0.0.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +18 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@govuk-pay/cli",
3
- "version": "0.0.61",
3
+ "version": "0.0.62",
4
4
  "description": "GOV.UK Pay Command Line Interface",
5
5
  "bin": {
6
6
  "pay": "bin/cli.js",
package/readme.md CHANGED
@@ -58,7 +58,7 @@ Config files needed by the pay cli will go in `$HOME/.pay-cli"
58
58
 
59
59
  #### Pay Local Config Files
60
60
 
61
- You can override environment variables set in the the .env files in [the pay local services local config directory](https://github.com/alphagov/pay-cli/tree/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services` for
61
+ You can override environment variables set in the .env files in [the pay local services local config directory](https://github.com/alphagov/pay-cli/tree/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services) for
62
62
  specific containers by placing files in `$HOME/.pay-cli/local/environment-overrides/<app_name>.env`.
63
63
 
64
64
  For example to override an environment variable for connector which was set in [connector.env](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services/connector.env)
@@ -67,6 +67,23 @@ you could create the file `$HOME/.pay-cli/local/environment-overrides/connector.
67
67
  Note: This will only override variables set in the .env files, it will not override any variables which get declared in an `environment` configuration option in the generated docker-compose files. These are generated from the
68
68
  [docker-compose.erb](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/docker-compose.erb#L5) template.
69
69
 
70
+ You can configure custom clusters by creating a file at `$HOME/.pay-cli/local/custom-clusters.yaml` following the schema:
71
+ ```yaml
72
+ clusters:
73
+ - name: my-cool-cluster
74
+ apps:
75
+ - connector
76
+ - selfservice
77
+ - frontend
78
+ - adminusers
79
+ - toolbox
80
+ - name: another-cool-cluster
81
+ apps:
82
+ - connector
83
+ - selfservice
84
+ - frontend
85
+ ```
86
+
70
87
  ## Vulnerability Disclosure
71
88
 
72
89
  GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. Please refer to our [vulnerability disclosure policy](https://www.gov.uk/help/report-vulnerability) and our [security.txt](https://vdp.cabinetoffice.gov.uk/.well-known/security.txt) file for details.