diff --git a/README-CLI-CLOUD.md b/README-CLI-CLOUD.md index 95e54082..29d3d5ca 100644 --- a/README-CLI-CLOUD.md +++ b/README-CLI-CLOUD.md @@ -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 @@ -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.
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.
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:
- `https://api.venafi.cloud` (US region).
- `https://api.venafi.eu` (EU region).
- `https://api.au.venafi.cloud` (AU region).
- `https://api.uk.venafi.cloud` (UK region).
If it's omitted, then VCert will default to US region.
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.
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.
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:
- `https://api.venafi.cloud` (US region).
- `https://api.venafi.eu` (EU region).
- `https://api.au.venafi.cloud` (AU region).
- `https://api.uk.venafi.cloud` (UK region).
- `https://api.sg.venafi.cloud` (SG region).
- `https://api.ca.venafi.cloud` (CA region).
If it's omitted, then VCert will default to US region.
Example: `-u https://api.venafi.eu` | +| `--verbose` | Use to increase the level of logging detail, which is helpful when troubleshooting issues. | ### Environment Variables @@ -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.). diff --git a/README-PLAYBOOK.md b/README-PLAYBOOK.md index 0e2e02f3..8a157bf8 100644 --- a/README-PLAYBOOK.md +++ b/README-PLAYBOOK.md @@ -110,12 +110,12 @@ The top-level structure of the file is described as follows: ### Connection -| Field | Type | TLSPDC | TLSPC | FIREFLY | Description | -|-------------|------------------------------------|----------------|----------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| credentials | [Credentials](#credentials) object | ***Required*** | ***Required*** | ***Required*** | A [Credential](#credentials) object that defines the credentials used to authenticate to the selected provider `platform`. | -| platform | string | ***Required*** | ***Required*** | ***Required*** | For TLS Protect Datacenter, either `tpp` or `tlspdc`.
For TLS Protect Cloud, either `vaas` or `tlspc`.
For Firefly, use `firefly`. | -| trustBundle | string | *Optional* | n/a | *Optional* | Used when [Connection.platform](#connection) is `tlspdc` or `firefly`.
Defines path to PEM-formatted trust bundle that contains the root (and optionally intermediate certificates) to use to trust the TLS connection. If omitted, will attempt to use operating system trusted CAs. | -| url | string | ***Required*** | *Optional* | ***Required*** | URL of the Venafi platform to connect to.
If url string does not include `https://`, it will be added automatically.
For connection to TLS Protect Datacenter, `url` must include the full API path (for example `https://tpp.company.com/vedsdk/`
For TLS Protect Cloud you can specify the url using this parameter. Currently we support the following regions:
- `https://api.venafi.cloud` (US region).
- `https://api.venafi.eu` (EU region).
- `https://api.au.venafi.cloud` (AU region).
- `https://api.uk.venafi.cloud` (UK region).
If not set, will default to US region. | +| Field | Type | TLSPDC | TLSPC | FIREFLY | Description | +|-------------|------------------------------------|----------------|----------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| credentials | [Credentials](#credentials) object | ***Required*** | ***Required*** | ***Required*** | A [Credential](#credentials) object that defines the credentials used to authenticate to the selected provider `platform`. | +| platform | string | ***Required*** | ***Required*** | ***Required*** | For TLS Protect Datacenter, either `tpp` or `tlspdc`.
For TLS Protect Cloud, either `vaas` or `tlspc`.
For Firefly, use `firefly`. | +| trustBundle | string | *Optional* | n/a | *Optional* | Used when [Connection.platform](#connection) is `tlspdc` or `firefly`.
Defines path to PEM-formatted trust bundle that contains the root (and optionally intermediate certificates) to use to trust the TLS connection. If omitted, will attempt to use operating system trusted CAs. | +| url | string | ***Required*** | *Optional* | ***Required*** | URL of the Venafi platform to connect to.
If url string does not include `https://`, it will be added automatically.
For connection to TLS Protect Datacenter, `url` must include the full API path (for example `https://tpp.company.com/vedsdk/`
For TLS Protect Cloud you can specify the url using this parameter. Currently we support the following regions:
- `https://api.venafi.cloud` (US region).
- `https://api.venafi.eu` (EU region).
- `https://api.au.venafi.cloud` (AU region).
- `https://api.uk.venafi.cloud` (UK region).
- `https://api.sg.venafi.cloud` (SG region).
- `https://api.ca.venafi.cloud` (CA region).
If not set, will default to US region. | ### Credentials