API reference

Packages:

addons.projectcapsule.dev/v1alpha1

addons.projectcapsule.dev/v1alpha1

Resource Types:

GlobalSopsSecret

GlobalSopsSecret is the Schema for the globalsopssecrets API.

Name	Type	Description	Required
apiVersion	string	addons.projectcapsule.dev/v1alpha1	true
kind	string	GlobalSopsSecret	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
sops	object	Metadata is stored in SOPS encrypted files, and it contains the information necessary to decrypt the file. This struct is just used for serialization, and SOPS uses another struct internally, sops.Metadata. It exists in order to allow the binary format to stay backwards compatible over time, but at the same time allow the internal representation SOPS uses to change over time.	true
spec	object	SopsSecretSpec defines the desired state of SopsSecret.	true
status	object	SopsSecretStatus defines the observed state of SopsSecret.	false

GlobalSopsSecret.sops

^{^{↩ Parent}}

Metadata is stored in SOPS encrypted files, and it contains the information necessary to decrypt the file. This struct is just used for serialization, and SOPS uses another struct internally, sops.Metadata. It exists in order to allow the binary format to stay backwards compatible over time, but at the same time allow the internal representation SOPS uses to change over time.

Name	Type	Required
lastmodified	string	true
mac	string	true
age	[]object	false
azure_kv	[]object	false
encrypted_comment_regex	string	false
encrypted_regex	string	false
encrypted_suffix	string	false
gcp_kms	[]object	false
hc_vault	[]object	false
hckms	[]object	false
key_groups	[]object	false
kms	[]object	false
mac_only_encrypted	boolean	false
pgp	[]object	false
shamir_threshold	integer	false
unencrypted_comment_regex	string	false
unencrypted_regex	string	false
unencrypted_suffix	string	false
version	string	false

GlobalSopsSecret.sops.age[index]

^{^{↩ Parent}}

Name	Type	Description	Required
enc	string		true
recipient	string		true

GlobalSopsSecret.sops.azure_kv[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
name	string	true
vault_url	string	true
version	string	true

GlobalSopsSecret.sops.gcp_kms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
resource_id	string	true

GlobalSopsSecret.sops.hc_vault[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
engine_path	string	true
key_name	string	true
vault_address	string	true

GlobalSopsSecret.sops.hckms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
key_id	string	true

GlobalSopsSecret.sops.key_groups[index]

^{^{↩ Parent}}

Name	Type	Required
age	[]object	false
azure_kv	[]object	false
gcp_kms	[]object	false
hc_vault	[]object	false
hckms	[]object	false
kms	[]object	false
pgp	[]object	false

GlobalSopsSecret.sops.key_groups[index].age[index]

^{^{↩ Parent}}

Name	Type	Description	Required
enc	string		true
recipient	string		true

GlobalSopsSecret.sops.key_groups[index].azure_kv[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
name	string	true
vault_url	string	true
version	string	true

GlobalSopsSecret.sops.key_groups[index].gcp_kms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
resource_id	string	true

GlobalSopsSecret.sops.key_groups[index].hc_vault[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
engine_path	string	true
key_name	string	true
vault_address	string	true

GlobalSopsSecret.sops.key_groups[index].hckms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
key_id	string	true

GlobalSopsSecret.sops.key_groups[index].kms[index]

^{^{↩ Parent}}

Name	Type	Required
arn	string	true
aws_profile	string	true
created_at	string	true
enc	string	true
context	map[string]string	false
role	string	false

GlobalSopsSecret.sops.key_groups[index].pgp[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	false
enc	string	false
fp	string	false

GlobalSopsSecret.sops.kms[index]

^{^{↩ Parent}}

Name	Type	Required
arn	string	true
aws_profile	string	true
created_at	string	true
enc	string	true
context	map[string]string	false
role	string	false

GlobalSopsSecret.sops.pgp[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	false
enc	string	false
fp	string	false

GlobalSopsSecret.spec

^{^{↩ Parent}}

SopsSecretSpec defines the desired state of SopsSecret.

Name	Type	Description	Required
secrets	[]object	Define Secrets to replicate, when secret is decrypted	true
metadata	object	Define additional Metadata for the generated secrets	false

GlobalSopsSecret.spec.secrets[index]

^{^{↩ Parent}}

GlobalSopsSecretItem defines the desired state of GlobalSopsSecret.

Name	Type	Description	Required
name	string	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names	true
namespace	string	Namespace must be declared since this is a cluster scoped resource	true
annotations	map[string]string	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels	false
data	map[string]string	Data map to use in Kubernetes secret (equivalent to Kubernetes Secret object data, please see for more information: https://kubernetes.io/docs/concepts/configuration/secret/#overview-of-secrets)	false
immutable	boolean	Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.	false
labels	map[string]string	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels	false
stringData	map[string]string	stringData map to use in Kubernetes secret (equivalent to Kubernetes Secret object stringData, please see for more information: https://kubernetes.io/docs/concepts/configuration/secret/#overview-of-secrets)	false
type	enum	Kubernetes secret type. Defaults to Opaque. Allowed values: - Opaque - kubernetes.io/service-account-token - kubernetes.io/dockercfg - kubernetes.io/dockerconfigjson - kubernetes.io/basic-auth - kubernetes.io/ssh-auth - kubernetes.io/tls - bootstrap.kubernetes.io/token Enum: Opaque, kubernetes.io/service-account-token, kubernetes.io/dockercfg, kubernetes.io/dockerconfigjson, kubernetes.io/basic-auth, kubernetes.io/ssh-auth, kubernetes.io/tls, bootstrap.kubernetes.io/token	false

GlobalSopsSecret.spec.metadata

^{^{↩ Parent}}

Define additional Metadata for the generated secrets

Name	Type	Description	Required
annotations	map[string]string	Annotations added to all generated Secrets	false
labels	map[string]string	Labels added to all generated Secrets	false
prefix	string	Prefix added to all generated Secrets names	false
suffix	string	Suffix added to all generated Secrets names	false

GlobalSopsSecret.status

^{^{↩ Parent}}

SopsSecretStatus defines the observed state of SopsSecret.

Name	Type	Description	Required
conditions	[]object	Conditions	true
condition	object	Deprecated: use conditions as list Conditions represent the latest available observations of an instances state	false
observedGeneration	integer	ObservedGeneration is the most recent generation the controller has observed. Format: int64	false
providers	[]object	Providers used on this secret	false
secrets	[]object	Secrets being replicated by this SopsSecret	false
size	integer	Amount of Secrets Default: 0	false

GlobalSopsSecret.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

GlobalSopsSecret.status.condition

^{^{↩ Parent}}

Deprecated: use conditions as list

Conditions represent the latest available observations of an instances state

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

GlobalSopsSecret.status.providers[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of Object	true
namespace	string	namespace of Object	false
uid	string	namespace of Object	false

GlobalSopsSecret.status.secrets[index]

^{^{↩ Parent}}

Name	Type	Description	Required
condition	object	Condition contains details for one aspect of the current state of this API Resource.	true
name	string		true
namespace	string		true
uid	string	UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.	false

GlobalSopsSecret.status.secrets[index].condition

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

SopsProvider

^{^{↩ Parent}}

SopsProvider is the Schema for the sopsproviders API.

Name	Type	Description	Required
apiVersion	string	addons.projectcapsule.dev/v1alpha1	true
kind	string	SopsProvider	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	SopsProviderSpec defines the desired state of SopsProvider.	true
status	object	SopsProviderStatus defines the observed state of SopsProvider.	false

SopsProvider.spec

^{^{↩ Parent}}

SopsProviderSpec defines the desired state of SopsProvider.

Name	Type	Description	Required
keys	[]object	Select namespaces or secrets where decryption information for this provider can be sourced from	true
sops	[]object	Selector Referencing which Secrets can be encrypted by this provider This selects effective SOPS Secrets	true

SopsProvider.spec.keys[index]

^{^{↩ Parent}}

Selector for resources and their labels or selecting origin namespaces

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false
namespaceSelector	object	NamespaceSelector for filtering namespaces by labels where items can be located in	false

SopsProvider.spec.keys[index].matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

SopsProvider.spec.keys[index].namespaceSelector

^{^{↩ Parent}}

NamespaceSelector for filtering namespaces by labels where items can be located in

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

SopsProvider.spec.keys[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

SopsProvider.spec.sops[index]

^{^{↩ Parent}}

Selector for resources and their labels or selecting origin namespaces

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false
namespaceSelector	object	NamespaceSelector for filtering namespaces by labels where items can be located in	false

SopsProvider.spec.sops[index].matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

SopsProvider.spec.sops[index].namespaceSelector

^{^{↩ Parent}}

NamespaceSelector for filtering namespaces by labels where items can be located in

Name	Type	Description	Required
matchExpressions	[]object	matchExpressions is a list of label selector requirements. The requirements are ANDed.	false
matchLabels	map[string]string	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.	false

SopsProvider.spec.sops[index].namespaceSelector.matchExpressions[index]

^{^{↩ Parent}}

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Name	Type	Description	Required
key	string	key is the label key that the selector applies to.	true
operator	string	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.	true
values	[]string	values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.	false

SopsProvider.status

^{^{↩ Parent}}

SopsProviderStatus defines the observed state of SopsProvider.

Name	Type	Description	Required
conditions	[]object	Conditions	true
condition	object	Deprecated: use conditions as list Conditions represent the latest available observations of an instances state	false
observedGeneration	integer	ObservedGeneration is the most recent generation the controller has observed. Format: int64	false
providers	[]object	List Validated Providers	false
size	integer	Amount of providers Default: 0	false

SopsProvider.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

SopsProvider.status.condition

^{^{↩ Parent}}

Deprecated: use conditions as list

Conditions represent the latest available observations of an instances state

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

SopsProvider.status.providers[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of Object	true
condition	object	Conditions represent the latest available observations of an instances state	false
namespace	string	namespace of Object	false
uid	string	namespace of Object	false

SopsProvider.status.providers[index].condition

^{^{↩ Parent}}

Conditions represent the latest available observations of an instances state

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

SopsSecret

^{^{↩ Parent}}

SopsSecret is the Schema for the sopssecrets API.

Name	Type	Description	Required
apiVersion	string	addons.projectcapsule.dev/v1alpha1	true
kind	string	SopsSecret	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
sops	object	Metadata is stored in SOPS encrypted files, and it contains the information necessary to decrypt the file. This struct is just used for serialization, and SOPS uses another struct internally, sops.Metadata. It exists in order to allow the binary format to stay backwards compatible over time, but at the same time allow the internal representation SOPS uses to change over time.	true
spec	object	SopsSecretSpec defines the desired state of SopsSecret.	true
status	object	SopsSecretStatus defines the observed state of SopsSecret.	false

SopsSecret.sops

^{^{↩ Parent}}

Name	Type	Required
lastmodified	string	true
mac	string	true
age	[]object	false
azure_kv	[]object	false
encrypted_comment_regex	string	false
encrypted_regex	string	false
encrypted_suffix	string	false
gcp_kms	[]object	false
hc_vault	[]object	false
hckms	[]object	false
key_groups	[]object	false
kms	[]object	false
mac_only_encrypted	boolean	false
pgp	[]object	false
shamir_threshold	integer	false
unencrypted_comment_regex	string	false
unencrypted_regex	string	false
unencrypted_suffix	string	false
version	string	false

SopsSecret.sops.age[index]

^{^{↩ Parent}}

Name	Type	Description	Required
enc	string		true
recipient	string		true

SopsSecret.sops.azure_kv[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
name	string	true
vault_url	string	true
version	string	true

SopsSecret.sops.gcp_kms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
resource_id	string	true

SopsSecret.sops.hc_vault[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
engine_path	string	true
key_name	string	true
vault_address	string	true

SopsSecret.sops.hckms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
key_id	string	true

SopsSecret.sops.key_groups[index]

^{^{↩ Parent}}

Name	Type	Required
age	[]object	false
azure_kv	[]object	false
gcp_kms	[]object	false
hc_vault	[]object	false
hckms	[]object	false
kms	[]object	false
pgp	[]object	false

SopsSecret.sops.key_groups[index].age[index]

^{^{↩ Parent}}

Name	Type	Description	Required
enc	string		true
recipient	string		true

SopsSecret.sops.key_groups[index].azure_kv[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
name	string	true
vault_url	string	true
version	string	true

SopsSecret.sops.key_groups[index].gcp_kms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
resource_id	string	true

SopsSecret.sops.key_groups[index].hc_vault[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
engine_path	string	true
key_name	string	true
vault_address	string	true

SopsSecret.sops.key_groups[index].hckms[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	true
enc	string	true
key_id	string	true

SopsSecret.sops.key_groups[index].kms[index]

^{^{↩ Parent}}

Name	Type	Required
arn	string	true
aws_profile	string	true
created_at	string	true
enc	string	true
context	map[string]string	false
role	string	false

SopsSecret.sops.key_groups[index].pgp[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	false
enc	string	false
fp	string	false

SopsSecret.sops.kms[index]

^{^{↩ Parent}}

Name	Type	Required
arn	string	true
aws_profile	string	true
created_at	string	true
enc	string	true
context	map[string]string	false
role	string	false

SopsSecret.sops.pgp[index]

^{^{↩ Parent}}

Name	Type	Required
created_at	string	false
enc	string	false
fp	string	false

SopsSecret.spec

^{^{↩ Parent}}

SopsSecretSpec defines the desired state of SopsSecret.

Name	Type	Description	Required
secrets	[]object	Define Secrets to replicate, when secret is decrypted	true
metadata	object	Define additional Metadata for the generated secrets	false

SopsSecret.spec.secrets[index]

^{^{↩ Parent}}

SopsSecretTemplate defines the map of secrets to create

Name	Type	Description	Required
name	string	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names	true
annotations	map[string]string	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels	false
data	map[string]string	Data map to use in Kubernetes secret (equivalent to Kubernetes Secret object data, please see for more information: https://kubernetes.io/docs/concepts/configuration/secret/#overview-of-secrets)	false
immutable	boolean	Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.	false
labels	map[string]string	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels	false
stringData	map[string]string	stringData map to use in Kubernetes secret (equivalent to Kubernetes Secret object stringData, please see for more information: https://kubernetes.io/docs/concepts/configuration/secret/#overview-of-secrets)	false
type	enum	Kubernetes secret type. Defaults to Opaque. Allowed values: - Opaque - kubernetes.io/service-account-token - kubernetes.io/dockercfg - kubernetes.io/dockerconfigjson - kubernetes.io/basic-auth - kubernetes.io/ssh-auth - kubernetes.io/tls - bootstrap.kubernetes.io/token Enum: Opaque, kubernetes.io/service-account-token, kubernetes.io/dockercfg, kubernetes.io/dockerconfigjson, kubernetes.io/basic-auth, kubernetes.io/ssh-auth, kubernetes.io/tls, bootstrap.kubernetes.io/token	false

SopsSecret.spec.metadata

^{^{↩ Parent}}

Define additional Metadata for the generated secrets

Name	Type	Description	Required
annotations	map[string]string	Annotations added to all generated Secrets	false
labels	map[string]string	Labels added to all generated Secrets	false
prefix	string	Prefix added to all generated Secrets names	false
suffix	string	Suffix added to all generated Secrets names	false

SopsSecret.status

^{^{↩ Parent}}

SopsSecretStatus defines the observed state of SopsSecret.

Name	Type	Description	Required
conditions	[]object	Conditions	true
condition	object	Deprecated: use conditions as list Conditions represent the latest available observations of an instances state	false
observedGeneration	integer	ObservedGeneration is the most recent generation the controller has observed. Format: int64	false
providers	[]object	Providers used on this secret	false
secrets	[]object	Secrets being replicated by this SopsSecret	false
size	integer	Amount of Secrets Default: 0	false

SopsSecret.status.conditions[index]

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

SopsSecret.status.condition

^{^{↩ Parent}}

Deprecated: use conditions as list

Conditions represent the latest available observations of an instances state

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

SopsSecret.status.providers[index]

^{^{↩ Parent}}

Name	Type	Description	Required
name	string	Name of Object	true
namespace	string	namespace of Object	false
uid	string	namespace of Object	false

SopsSecret.status.secrets[index]

^{^{↩ Parent}}

Name	Type	Description	Required
condition	object	Condition contains details for one aspect of the current state of this API Resource.	true
name	string		true
namespace	string		true
uid	string	UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.	false

SopsSecret.status.secrets[index].condition

^{^{↩ Parent}}

Condition contains details for one aspect of the current state of this API Resource.

Name	Type	Description	Required
lastTransitionTime	string	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time	true
message	string	message is a human readable message indicating details about the transition. This may be an empty string.	true
reason	string	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.	true
status	enum	status of the condition, one of True, False, Unknown. Enum: True, False, Unknown	true
type	string	type of condition in CamelCase or in foo.example.com/CamelCase.	true
observedGeneration	integer	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 Minimum: 0	false

Contributing

API reference

addons.projectcapsule.dev/v1alpha1

GlobalSopsSecret#

GlobalSopsSecret.sops#

GlobalSopsSecret.sops.age[index]#

GlobalSopsSecret.sops.azure_kv[index]#

GlobalSopsSecret.sops.gcp_kms[index]#

GlobalSopsSecret.sops.hc_vault[index]#

GlobalSopsSecret.sops.hckms[index]#

GlobalSopsSecret.sops.key_groups[index]#

GlobalSopsSecret.sops.key_groups[index].age[index]#

GlobalSopsSecret.sops.key_groups[index].azure_kv[index]#

GlobalSopsSecret.sops.key_groups[index].gcp_kms[index]#

GlobalSopsSecret.sops.key_groups[index].hc_vault[index]#

GlobalSopsSecret.sops.key_groups[index].hckms[index]#

GlobalSopsSecret.sops.key_groups[index].kms[index]#

GlobalSopsSecret.sops.key_groups[index].pgp[index]#

GlobalSopsSecret.sops.kms[index]#

GlobalSopsSecret.sops.pgp[index]#

GlobalSopsSecret.spec#

GlobalSopsSecret.spec.secrets[index]#

GlobalSopsSecret.spec.metadata#

GlobalSopsSecret.status#

GlobalSopsSecret.status.conditions[index]#

GlobalSopsSecret.status.condition#

GlobalSopsSecret.status.providers[index]#

GlobalSopsSecret.status.secrets[index]#

GlobalSopsSecret.status.secrets[index].condition#

SopsProvider#

SopsProvider.spec#

SopsProvider.spec.keys[index]#

SopsProvider.spec.keys[index].matchExpressions[index]#

SopsProvider.spec.keys[index].namespaceSelector#

SopsProvider.spec.keys[index].namespaceSelector.matchExpressions[index]#

SopsProvider.spec.sops[index]#

SopsProvider.spec.sops[index].matchExpressions[index]#

SopsProvider.spec.sops[index].namespaceSelector#

SopsProvider.spec.sops[index].namespaceSelector.matchExpressions[index]#

SopsProvider.status#

SopsProvider.status.conditions[index]#

SopsProvider.status.condition#

SopsProvider.status.providers[index]#

SopsProvider.status.providers[index].condition#

SopsSecret#

SopsSecret.sops#

SopsSecret.sops.age[index]#

SopsSecret.sops.azure_kv[index]#

SopsSecret.sops.gcp_kms[index]#

SopsSecret.sops.hc_vault[index]#

SopsSecret.sops.hckms[index]#

SopsSecret.sops.key_groups[index]#

SopsSecret.sops.key_groups[index].age[index]#

SopsSecret.sops.key_groups[index].azure_kv[index]#

SopsSecret.sops.key_groups[index].gcp_kms[index]#

SopsSecret.sops.key_groups[index].hc_vault[index]#

SopsSecret.sops.key_groups[index].hckms[index]#

SopsSecret.sops.key_groups[index].kms[index]#

SopsSecret.sops.key_groups[index].pgp[index]#

SopsSecret.sops.kms[index]#

SopsSecret.sops.pgp[index]#

SopsSecret.spec#

SopsSecret.spec.secrets[index]#

SopsSecret.spec.metadata#

SopsSecret.status#

SopsSecret.status.conditions[index]#

SopsSecret.status.condition#

SopsSecret.status.providers[index]#

SopsSecret.status.secrets[index]#

SopsSecret.status.secrets[index].condition#

GlobalSopsSecret

GlobalSopsSecret.sops

GlobalSopsSecret.sops.age[index]

GlobalSopsSecret.sops.azure_kv[index]

GlobalSopsSecret.sops.gcp_kms[index]

GlobalSopsSecret.sops.hc_vault[index]

GlobalSopsSecret.sops.hckms[index]

GlobalSopsSecret.sops.key_groups[index]

GlobalSopsSecret.sops.key_groups[index].age[index]

GlobalSopsSecret.sops.key_groups[index].azure_kv[index]

GlobalSopsSecret.sops.key_groups[index].gcp_kms[index]

GlobalSopsSecret.sops.key_groups[index].hc_vault[index]

GlobalSopsSecret.sops.key_groups[index].hckms[index]

GlobalSopsSecret.sops.key_groups[index].kms[index]

GlobalSopsSecret.sops.key_groups[index].pgp[index]

GlobalSopsSecret.sops.kms[index]

GlobalSopsSecret.sops.pgp[index]

GlobalSopsSecret.spec

GlobalSopsSecret.spec.secrets[index]

GlobalSopsSecret.spec.metadata

GlobalSopsSecret.status

GlobalSopsSecret.status.conditions[index]

GlobalSopsSecret.status.condition

GlobalSopsSecret.status.providers[index]

GlobalSopsSecret.status.secrets[index]

GlobalSopsSecret.status.secrets[index].condition

SopsProvider

SopsProvider.spec

SopsProvider.spec.keys[index]

SopsProvider.spec.keys[index].matchExpressions[index]

SopsProvider.spec.keys[index].namespaceSelector

SopsProvider.spec.keys[index].namespaceSelector.matchExpressions[index]

SopsProvider.spec.sops[index]

SopsProvider.spec.sops[index].matchExpressions[index]

SopsProvider.spec.sops[index].namespaceSelector

SopsProvider.spec.sops[index].namespaceSelector.matchExpressions[index]

SopsProvider.status

SopsProvider.status.conditions[index]

SopsProvider.status.condition

SopsProvider.status.providers[index]

SopsProvider.status.providers[index].condition

SopsSecret

SopsSecret.sops

SopsSecret.sops.age[index]

SopsSecret.sops.azure_kv[index]

SopsSecret.sops.gcp_kms[index]

SopsSecret.sops.hc_vault[index]

SopsSecret.sops.hckms[index]

SopsSecret.sops.key_groups[index]

SopsSecret.sops.key_groups[index].age[index]

SopsSecret.sops.key_groups[index].azure_kv[index]

SopsSecret.sops.key_groups[index].gcp_kms[index]

SopsSecret.sops.key_groups[index].hc_vault[index]

SopsSecret.sops.key_groups[index].hckms[index]

SopsSecret.sops.key_groups[index].kms[index]

SopsSecret.sops.key_groups[index].pgp[index]

SopsSecret.sops.kms[index]

SopsSecret.sops.pgp[index]

SopsSecret.spec

SopsSecret.spec.secrets[index]

SopsSecret.spec.metadata

SopsSecret.status

SopsSecret.status.conditions[index]

SopsSecret.status.condition

SopsSecret.status.providers[index]

SopsSecret.status.secrets[index]

SopsSecret.status.secrets[index].condition