Skip to content
Open
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions doc/ovhcloud_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, O
* [ovhcloud cloud alerting](ovhcloud_cloud_alerting.md) - Manage billing alert configurations in the given cloud project
* [ovhcloud cloud instance](ovhcloud_cloud_instance.md) - Manage instances in the given cloud project
* [ovhcloud cloud ip](ovhcloud_cloud_ip.md) - Manage public IPs (floating and failover) in the given cloud project
* [ovhcloud cloud key-manager](ovhcloud_cloud_key-manager.md) - Manage Key Management Service (KMS) resources in the given cloud project
* [ovhcloud cloud loadbalancer](ovhcloud_cloud_loadbalancer.md) - Manage loadbalancers in the given cloud project
* [ovhcloud cloud managed-analytics](ovhcloud_cloud_managed-analytics.md) - Manage managed analytics services in the given cloud project
* [ovhcloud cloud managed-database](ovhcloud_cloud_managed-database.md) - Manage managed database services in the given cloud project
Expand Down
36 changes: 36 additions & 0 deletions doc/ovhcloud_cloud_key-manager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## ovhcloud cloud key-manager

Manage Key Management Service (KMS) resources in the given cloud project

### Options

```
--cloud-project string Cloud project ID
-h, --help help for key-manager
```

### Options inherited from parent commands

```
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud](ovhcloud_cloud.md) - Manage your projects and services in the Public Cloud universe (MKS, MPR, MRS, Object Storage...)
* [ovhcloud cloud key-manager container](ovhcloud_cloud_key-manager_container.md) - Manage Key Manager containers
* [ovhcloud cloud key-manager secret](ovhcloud_cloud_key-manager_secret.md) - Manage Key Manager secrets

40 changes: 40 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## ovhcloud cloud key-manager container

Manage Key Manager containers

### Options

```
-h, --help help for container
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager](ovhcloud_cloud_key-manager.md) - Manage Key Management Service (KMS) resources in the given cloud project
* [ovhcloud cloud key-manager container consumer](ovhcloud_cloud_key-manager_container_consumer.md) - Manage consumers of a Key Manager container
* [ovhcloud cloud key-manager container create](ovhcloud_cloud_key-manager_container_create.md) - Create a new Key Manager container
* [ovhcloud cloud key-manager container delete](ovhcloud_cloud_key-manager_container_delete.md) - Delete the given Key Manager container
* [ovhcloud cloud key-manager container edit](ovhcloud_cloud_key-manager_container_edit.md) - Edit the given Key Manager container (only secret references are mutable)
* [ovhcloud cloud key-manager container get](ovhcloud_cloud_key-manager_container_get.md) - Get a specific Key Manager container
* [ovhcloud cloud key-manager container list](ovhcloud_cloud_key-manager_container_list.md) - List Key Manager containers

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container_consumer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud key-manager container consumer

Manage consumers of a Key Manager container

### Options

```
-h, --help help for consumer
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager container](ovhcloud_cloud_key-manager_container.md) - Manage Key Manager containers
* [ovhcloud cloud key-manager container consumer delete](ovhcloud_cloud_key-manager_container_consumer_delete.md) - Delete a consumer from the given container
* [ovhcloud cloud key-manager container consumer get](ovhcloud_cloud_key-manager_container_consumer_get.md) - Get a specific consumer of the given container
* [ovhcloud cloud key-manager container consumer list](ovhcloud_cloud_key-manager_container_consumer_list.md) - List consumers registered for the given container
* [ovhcloud cloud key-manager container consumer register](ovhcloud_cloud_key-manager_container_consumer_register.md) - Register a consumer for the given container

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container_consumer_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud key-manager container consumer delete

Delete a consumer from the given container

```
ovhcloud cloud key-manager container consumer delete <container_id> <consumer_id> [flags]
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager container consumer](ovhcloud_cloud_key-manager_container_consumer.md) - Manage consumers of a Key Manager container

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container_consumer_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud key-manager container consumer get

Get a specific consumer of the given container

```
ovhcloud cloud key-manager container consumer get <container_id> <consumer_id> [flags]
```

### Options

```
-h, --help help for get
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager container consumer](ovhcloud_cloud_key-manager_container_consumer.md) - Manage consumers of a Key Manager container

45 changes: 45 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container_consumer_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## ovhcloud cloud key-manager container consumer list

List consumers registered for the given container

```
ovhcloud cloud key-manager container consumer list <container_id> [flags]
```

### Options

```
--filter stringArray Filter results by any property using https://github.com/PaesslerAG/gval syntax
Examples:
--filter 'state=="running"'
--filter 'name=~"^my.*"'
--filter 'nested.property.subproperty>10'
--filter 'startDate>="2023-12-01"'
--filter 'name=~"something" && nbField>10'
-h, --help help for list
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager container consumer](ovhcloud_cloud_key-manager_container_consumer.md) - Manage consumers of a Key Manager container

41 changes: 41 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container_consumer_register.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## ovhcloud cloud key-manager container consumer register

Register a consumer for the given container

```
ovhcloud cloud key-manager container consumer register <container_id> [flags]
```

### Options

```
-h, --help help for register
--resource-id string UUID of the resource consuming the secret/container
--resource-type string Type of the consuming resource (IMAGE, INSTANCE, LOADBALANCER)
--service string OpenStack service type of the consumer (COMPUTE, IMAGE, LOADBALANCER, NETWORK)
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager container consumer](ovhcloud_cloud_key-manager_container_consumer.md) - Manage consumers of a Key Manager container

48 changes: 48 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
## ovhcloud cloud key-manager container create

Create a new Key Manager container

```
ovhcloud cloud key-manager container create [flags]
```

### Options

```
--availability-zone string Availability zone within the region
--editor Use a text editor to define parameters
--from-file string File containing parameters
-h, --help help for create
--init-file string Create a file with example parameters
--name string Desired container name
--region string Region code where the container is located
--replace Replace parameters file if it already exists
--secret-ref stringArray Secret reference as '<name>=<secretId>' (repeatable)
--type string Type of the container (CERTIFICATE, GENERIC, RSA)
--wait Wait for the container to be ready before exiting
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager container](ovhcloud_cloud_key-manager_container.md) - Manage Key Manager containers

38 changes: 38 additions & 0 deletions doc/ovhcloud_cloud_key-manager_container_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## ovhcloud cloud key-manager container delete

Delete the given Key Manager container

```
ovhcloud cloud key-manager container delete <container_id> [flags]
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
--cloud-project string Cloud project ID
-d, --debug Activate debug mode (will log all HTTP requests details)
-e, --ignore-errors Ignore errors in API calls when it is not fatal to the execution
-o, --output string Output format: json, yaml, interactive, or a custom format expression (using https://github.com/PaesslerAG/gval syntax)
Examples:
--output json
--output yaml
--output interactive
--output 'id' (to extract a single field)
--output 'nested.field.subfield' (to extract a nested field)
--output '[id, "name"]' (to extract multiple fields as an array)
--output '{"newKey": oldKey, "otherKey": nested.field}' (to extract and rename fields in an object)
--output 'name+","+type' (to extract and concatenate fields in a string)
--output '(nbFieldA + nbFieldB) * 10' (to compute values from numeric fields)
--profile string Use a specific profile from the configuration file
```

### SEE ALSO

* [ovhcloud cloud key-manager container](ovhcloud_cloud_key-manager_container.md) - Manage Key Manager containers

Loading
Loading