Skip to content

Updates docs to reflect Singapore and Canada regions #560

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

Merged
luispresuelVenafi merged 1 commit into from
May 19, 2025
Merged

Updates docs to reflect Singapore and Canada regions #560

Show file tree
Hide file tree
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
32 changes: 18 additions & 14 deletions README-CLI-CLOUD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ Review these prerequisites to get started. You'll need the following:
- [https://api.venafi.eu](https://api.eu.venafi.cloud/vaas) [EU]
- [https://api.au.venafi.cloud](https://api.au.venafi.cloud/vaas) [AU]
- [https://api.uk.venafi.cloud](https://api.uk.venafi.cloud/vaas) [UK]
- [https://api.sg.venafi.cloud](https://api.sg.venafi.cloud/vaas) [SG]
- [https://api.ca.venafi.cloud](https://api.ca.venafi.cloud/vaas) [CA]
2. You have successfully registered for a Venafi Control Plane account, have been granted at least the "Resource Owner"
role, and know your API key. You can use the `getcred` action to
[register and obtain an API key](#registering-and-obtaining-an-api-key), but you will need an administrator to update
Expand Down Expand Up @@ -81,19 +83,19 @@ have configured a service account, the service account has been granted the "Res

The following options apply to the `enroll`, `pickup`, and `renew` actions:

| Flag | Description |
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--config` | Use to specify INI configuration file containing connection details. Available parameters: `cloud_apikey`, `cloud_zone`, `trust_bundle`, `test_mode`. |
| `-k` or `--apiKey` | Use to specify your API key for Venafi Control Plane.<br/>Example: -k aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
| `--no-prompt` | Use to exclude password prompts. If you enable the prompt and you enter incorrect information, an error is displayed. This option is useful with scripting. |
| `-p` or `--platform` | Use to specify Venafi Control Plane as the platform of choice to connect. Accepted value is `vcp`, case-insensitive. |
| `-t` or `--token` | Use to specify an access token for Venafi Control Plane. You need to set `--platform vcp` or `-p vcp` in order to use access tokens for Venafi Control Plane. |
| `--test-mode` | Use to test operations without connecting to Venafi Control Plane. This option is useful for integration tests where the test environment does not have access to Venafi Control Plane. Default is false. |
| `--test-mode-delay` | Use to specify the maximum number of seconds for the random test-mode connection delay. Default is 15 (seconds). |
| `--timeout` | Use to specify the maximum amount of time to wait in seconds for a certificate to be processed by Venafi Control Plane. Default is 120 (seconds). |
| `--trust-bundle` | Use to specify a file with PEM formatted certificates to be used as trust anchors when communicating with Venafi Control Plane. Generally not needed because VCP is secured by a publicly trusted certificate, but it may be needed if your organization requires VCert to traverse a proxy server. VCert uses the trust store of your operating system for this purpose if not specified.<br/>Example: `--trust-bundle /path-to/bundle.pem` |
| `-u` or `--url` | Use to specify the URL of the Venafi Control Plane API server. Currently, we support the following regions:<br/>- `https://api.venafi.cloud` (US region).<br/>- `https://api.venafi.eu` (EU region).<br/>- `https://api.au.venafi.cloud` (AU region).<br/> - `https://api.uk.venafi.cloud` (UK region).<br/> If it's omitted, then VCert will default to US region. <br/>Example: `-u https://api.venafi.eu` |
| `--verbose` | Use to increase the level of logging detail, which is helpful when troubleshooting issues. |
| Flag | Description |
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--config` | Use to specify INI configuration file containing connection details. Available parameters: `cloud_apikey`, `cloud_zone`, `trust_bundle`, `test_mode`. |
| `-k` or `--apiKey` | Use to specify your API key for Venafi Control Plane.<br/>Example: -k aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
| `--no-prompt` | Use to exclude password prompts. If you enable the prompt and you enter incorrect information, an error is displayed. This option is useful with scripting. |
| `-p` or `--platform` | Use to specify Venafi Control Plane as the platform of choice to connect. Accepted value is `vcp`, case-insensitive. |
| `-t` or `--token` | Use to specify an access token for Venafi Control Plane. You need to set `--platform vcp` or `-p vcp` in order to use access tokens for Venafi Control Plane. |
| `--test-mode` | Use to test operations without connecting to Venafi Control Plane. This option is useful for integration tests where the test environment does not have access to Venafi Control Plane. Default is false. |
| `--test-mode-delay` | Use to specify the maximum number of seconds for the random test-mode connection delay. Default is 15 (seconds). |
| `--timeout` | Use to specify the maximum amount of time to wait in seconds for a certificate to be processed by Venafi Control Plane. Default is 120 (seconds). |
| `--trust-bundle` | Use to specify a file with PEM formatted certificates to be used as trust anchors when communicating with Venafi Control Plane. Generally not needed because VCP is secured by a publicly trusted certificate, but it may be needed if your organization requires VCert to traverse a proxy server. VCert uses the trust store of your operating system for this purpose if not specified.<br/>Example: `--trust-bundle /path-to/bundle.pem` |
| `-u` or `--url` | Use to specify the URL of the Venafi Control Plane API server. Currently, we support the following regions:<br/>- `https://api.venafi.cloud` (US region).<br/>- `https://api.venafi.eu` (EU region).<br/>- `https://api.au.venafi.cloud` (AU region).<br/> - `https://api.uk.venafi.cloud` (UK region).<br/> - `https://api.sg.venafi.cloud` (SG region).<br/> - `https://api.ca.venafi.cloud` (CA region).<br/> If it's omitted, then VCert will default to US region. <br/>Example: `-u https://api.venafi.eu` |
| `--verbose` | Use to increase the level of logging detail, which is helpful when troubleshooting issues. |

### Environment Variables

Expand Down Expand Up @@ -310,7 +312,9 @@ For the purposes of the following examples, assume the following:
- [https://api.venafi.cloud](https://api.venafi.cloud/vaas) [US]
- [https://api.venafi.eu](https://api.eu.venafi.cloud/vaas) [EU]
- [https://api.au.venafi.cloud](https://api.au.venafi.cloud/vaas) [AU]
- [https://api.uk.venafi.cloud](https://api.uk.venafi.cloud/vaas) [AU]
- [https://api.uk.venafi.cloud](https://api.uk.venafi.cloud/vaas) [UK]
- [https://api.sg.venafi.cloud](https://api.sg.venafi.cloud/vaas) [SG]
- [https://api.ca.venafi.cloud](https://api.ca.venafi.cloud/vaas) [CA]
- A user has been registered and granted at least the `OP Resource Owner` role and has an API key.
- A CA Account and Issuing Template have been created and configured appropriately (organization, city, state, country,
key length, allowed domains, etc.).
Expand Down
Loading