Skip to content
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.

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

Added gcp command line options #234

Merged
merged 2 commits into from
Dec 1, 2023
Merged
Changes from all commits
Commits
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
100 changes: 100 additions & 0 deletions docs/reference/cli/subcommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -1454,6 +1454,106 @@ eth2.azure-vault-name: "AzureKeyVault"
Name of the vault to access.
Subdomain of `vault.azure.net`.

#### `gcp-project-id`

<!--tabs-->

# Syntax

```bash
--gcp-project-id=<STRING>
```

# Example

```bash
--gcp-project-id=my-project
```

# Environment variable

```bash
WEB3SIGNER_ETH2_GCP_PROJECT_ID=my-project
```

# Configuration file

```bash
eth2.gcp-project-id: "my-project"
```

<!--/tabs-->

Globally unique identifier for the Google Cloud Platform (GCP) project where the
secrets to be used by Web3Signer are stored.

#### `gcp-secrets-enabled`

<!--tabs-->

# Syntax

```bash
--gcp-secrets-enabled=<BOOLEAN>
```

# Example

```bash
--gcp-secrets-enabled=true
```

# Environment variable

```bash
WEB3SIGNER_ETH2_GCP_SECRETS_ENABLED=true
```

# Configuration file

```bash
eth2.gcp-secrets-enabled: true
```

<!--/tabs-->

Set to `true` to enable bulk loading from the GCP Secrets Manager service. The default is `false`.

#### `gcp-secrets-filter`

<!--tabs-->

# Syntax

```bash
--gcp-secrets-filter=<STRING>
```

# Example

```bash
--gcp-secrets-filter=my-secrets-filter
```

# Environment variable

```bash
WEB3SIGNER_ETH2_GCP_SECRETS_FILTER=my-secrets-filter
```

# Configuration file

```bash
eth2.gcp-secrets-filter: "my-secrets-filter"
```

<!--/tabs-->

Filter to use when loading secrets into Web3Signer. [List operation filtering](https://cloud.google.com/secret-manager/docs/filtering) is applied.

Only secrets matching the filter are loaded. If not specified, all secrets from the project identified by
[`--gcp-project-id`](#gcp-project-id) are loaded.

#### `key-manager-api-enabled`

<!--tabs-->
Expand Down