oci key management vault

Overview

A vault to manage keys.

Here is an example on how to use this:

oci_key_management_vault { 'tenant (root)/my_vault:
  ensure        => 'present',
  vault_type    => 'DEFAULT',
}

This documentation is generated from the Ruby OCI SDK.

Attributes

Attribute Name	Short Description
absent_states	The OCI states, puppet will detect as the resource being absent.
compartment	The Puppet name of the resource identified by `compartment_id`.
compartment_id	The OCID of the compartment that contains the object.
crypto_endpoint

defined_tags	Defined tags for this resource.
disable_corrective_change	Disable the modification of a resource when Puppet decides it is a corrective change.
disable_corrective_ensure	Disable the creation or removal of a resource when Puppet decides is a corrective change.
ensure	The basic property that the resource should be in.
freeform_tags	Free-form tags for this resource.
id	The OCID of the resource.
lifecycle_state

management_endpoint

name	The full name of the object.
oci_timeout	The maximum time to wait for the OCI resource to be in the ready state.
oci_wait_interval	The interval beween calls to OCI to check if a resource is in the ready state.
present_states	The OCI states, puppet will detect as the resource being present.
provider	resource.
synchronized	Specifies if Puppet waits for OCI actions to be ready before moving on to an other resource.
tenant	The tenant for this resource.
time_created

time_of_deletion

vault_name	The name of the vault.
vault_type	The type of vault to create.
wrappingkey

wrappingkey_id

absent_states

The OCI states, puppet will detect as the resource being absent.

Back to overview of oci_key_management_vault

compartment

The Puppet name of the resource identified by compartment_id.

See the documentation of compartment_id for all details.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_key_management_vault

compartment_id

The OCID of the compartment that contains the object.

Rather use the property compartment instead of a direct OCID reference.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_key_management_vault

crypto_endpoint

Back to overview of oci_key_management_vault

defined_tags

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_key_management_vault

disable_corrective_change

Disable the modification of a resource when Puppet decides it is a corrective change.

(requires easy_type V2.11.0 or higher)

When using a Puppet Server, Puppet knows about adaptive and corrective changes. A corrective change is when Puppet notices that the resource has changed, but the catalog has not changed. This can occur for example, when a user, by accident or willingly, changed something on the system that Puppet is managing. The normal Puppet process then repairs this and puts the resource back in the state as defined in the catalog. This process is precisely what you want most of the time, but not always. This can sometimes also occur when a hardware or network error occurs. Then Puppet cannot correctly determine the current state of the system and thinks the resource is changed, while in fact, it is not. Letting Puppet recreate remove or change the resource in these cases, is NOT wat you want.

Using the disable_corrective_change parameter, you can disable corrective changes on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ...
  disable_corrective_change => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not modify the resource and signal an error:

    Error: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/parameter: change from '10' to '20' failed: Corrective change present requested by catalog, but disabled by parameter disable_corrective_change. (corrective)

Back to overview of oci_key_management_vault

disable_corrective_ensure

Disable the creation or removal of a resource when Puppet decides is a corrective change.

(requires easy_type V2.11.0 or higher)

Using the disable_corrective_ensure parameter, you can disable corrective ensure present or ensure absent actions on the current resource.

Here is an example of this:

crucial_resource {'be_carefull':
  ensure                    => 'present',
  ...
  disable_corrective_ensure => true,
  ...
}

When a corrective ensure does happen on the resource Puppet will not create or remove the resource and signal an error:

    Error: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure.
    Error: /Stage[main]/Main/Crucial_resource[be_carefull]/ensure: change from 'absent' to 'present' failed: Corrective ensure present requested by catalog, but disabled by parameter disable_corrective_ensure. (corrective)

Back to overview of oci_key_management_vault

ensure

The basic property that the resource should be in.

Valid values are present, absent.

Back to overview of oci_key_management_vault

freeform_tags

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_key_management_vault

id

The OCID of the resource. This is a read-only property.

This documentation is generated from the Ruby OCI SDK.

Back to overview of oci_key_management_vault

lifecycle_state

Back to overview of oci_key_management_vault

management_endpoint

Back to overview of oci_key_management_vault

name

The full name of the object.

Back to overview of oci_key_management_vault

oci_timeout

The maximum time to wait for the OCI resource to be in the ready state.

Back to overview of oci_key_management_vault

oci_wait_interval

The interval beween calls to OCI to check if a resource is in the ready state.

Back to overview of oci_key_management_vault

present_states

The OCI states, puppet will detect as the resource being present.

Back to overview of oci_key_management_vault

provider

The specific backend to use for this oci_key_management_vault resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.Available providers are: