Skip to main content

Provider

Provider is the schema for provider definitions in terraform controller

Full name:
providers.terraform.appvia.io
Group:
terraform.appvia.io
Singular name:
provider
Plural name:
providers
Scope:
Cluster
Versions:
v1alpha1

Version v1alpha1

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object

.spec

object

ProviderSpec defines the desired state of a provider

.spec.configuration

object

Configuration is optional configuration to the provider. This is terraform provider specific.

.spec.preload

object

Preload defines the configuration for the preloading of contextual data from the cloud vendor.

.spec.preload.cluster

string

Cluster is the name of the kubernetes cluster we use to pivot the data around

.spec.preload.context

string

Context is the context name of the Context we should create from the preload implementation

.spec.preload.enabled

boolean

Enabled indicates if the preloader is enabled

.spec.preload.interval

string

Interval is the interval to run the preloader

.spec.preload.region

string

Region is the cloud region the cluster is location in

.spec.provider

stringRequired

ProviderType defines the cloud provider which is being used, currently supported providers are aws, google or azurerm.

.spec.secretRef

object

SecretRef is a reference to a kubernetes secret. This is required only when using the source: secret. The secret should include the environment variables required to by the terraform provider.

.spec.secretRef.name

string

name is unique within a namespace to reference a secret resource.

.spec.secretRef.namespace

string

namespace defines the space within which the secret name must be unique.

.spec.selector

object

Selector provider the ability to filter who can use this provider. If empty, all users in the cluster is permitted to use the provider. Otherrise you can specify a selector which can use namespace and resource labels

.spec.selector.namespace

object

Namespace is used to filter a configuration based on the namespace labels of where it exists

.spec.selector.namespace.matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

.spec.selector.namespace.matchExpressions[*]

object

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

.spec.selector.namespace.matchExpressions[*].key

stringRequired

key is the label key that the selector applies to.

.spec.selector.namespace.matchExpressions[*].operator

stringRequired

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.selector.namespace.matchExpressions[*].values

array

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.

.spec.selector.namespace.matchExpressions[*].values[*]

string

.spec.selector.namespace.matchLabels

object

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.

.spec.selector.resource

object

Resource provides the ability to filter a configuration based on it’s labels

.spec.selector.resource.matchExpressions

array

matchExpressions is a list of label selector requirements. The requirements are ANDed.

.spec.selector.resource.matchExpressions[*]

object

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

.spec.selector.resource.matchExpressions[*].key

stringRequired

key is the label key that the selector applies to.

.spec.selector.resource.matchExpressions[*].operator

stringRequired

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

.spec.selector.resource.matchExpressions[*].values

array

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.

.spec.selector.resource.matchExpressions[*].values[*]

string

.spec.selector.resource.matchLabels

object

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.

.spec.serviceAccount

string

ServiceAccount is the name of a service account to use when the provider source is ‘injected’. The service account should exist in the terraform controller namespace and be configure per cloud vendor requirements for pod identity.

.spec.source

stringRequired

Source defines the type of credentials the provider is wrapper, this could be wrapping a static secret or using a managed identity. The currently supported values are secret and injected.

.spec.summary

string

Summary provides a human readable description of the provider

.status

object

ProviderStatus defines the observed state of a provider

.status.conditions

array

Conditions represents the observations of the resource’s current state.

.status.conditions[*]

object

Condition is the current observed condition of some aspect of a resource

.status.conditions[*].detail

string

Detail is any additional human-readable detail to understand this condition, for example, the full underlying error which caused an issue

.status.conditions[*].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.

.status.conditions[*].message

string

Message is a human readable message indicating details about the transition. This may be an empty string.

.status.conditions[*].name

stringRequired

Name is a human-readable name for this condition.

.status.conditions[*].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.

.status.conditions[*].reason

stringRequired

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.

.status.conditions[*].status

stringRequired

Status of the condition, one of True, False, Unknown.

.status.conditions[*].type

stringRequired

Type of condition in CamelCase or in foo.example.com/CamelCase. — Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

.status.lastPreloadTime

string

LastPreloadTime is the last time the provider was used to run a preload job

.status.lastReconcile

object

LastReconcile describes the generation and time of the last reconciliation

.status.lastReconcile.generation

integer

Generation is the generation reconciled on the last reconciliation

.status.lastReconcile.time

string

Time is the last time the resource was reconciled

.status.lastSuccess

object

LastSuccess descibes the generation and time of the last reconciliation which resulted in a Success status

.status.lastSuccess.generation

integer

Generation is the generation reconciled on the last reconciliation

.status.lastSuccess.time

string

Time is the last time the resource was reconciled