Skip to main content

Configuration

Configuration is the schema for terraform definitions in terraform controller

Full name:
configurations.terraform.appvia.io
Group:
terraform.appvia.io
Singular name:
configuration
Plural name:
configurations
Scope:
Namespaced
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

ConfigurationSpec defines the desired state of a terraform

.spec.auth

object

Auth is used to configure any options required when the source of the terraform module is private or requires credentials to retrieve. This could be SSH keys or git user/pass or AWS credentials for an s3 bucket.

.spec.auth.name

string

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

.spec.auth.namespace

string

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

.spec.enableAutoApproval

boolean

EnableAutoApproval when enabled indicates the configuration does not need to be manually approved. On a change to the configuration, the controller will automatically approve the configuration. Note it still needs to adhere to any checks or policies.

.spec.enableDriftDetection

boolean

EnableDriftDetection when enabled run periodic reconciliation configurations looking for any drift between the expected and current state. If any drift is detected the status is changed and a kubernetes event raised.

.spec.module

stringRequired

Module is the URL to the source of the terraform module. The format of the URL is a direct implementation of terraform’s module reference. Please see the following repository for more details https://github.com/hashicorp/go-getter

.spec.providerRef

objectRequired

ProviderRef is the reference to the provider which should be used to execute this configuration.

.spec.providerRef.name

stringRequired

Name is the name of the provider which contains the credentials to use for this configuration.

.spec.providerRef.namespace

string

Namespace is the namespace of the provider itself.

.spec.terraformVersion

string

TerraformVersion provides the ability to override the default terraform version. Before changing this field its best to consult with platform administrator. As the value of this field is used to change the tag of the terraform container image.

.spec.valueFrom

array

ValueFromSource is a collection of value from sources, where the source of the value is is taken from a secret

.spec.valueFrom[*]

object

ValueFromSource defines a value which is taken from a secret

.spec.valueFrom[*].key

stringRequired

Key is the key in the secret which we should used for the value

.spec.valueFrom[*].optional

boolean

Optional indicates the secret can be optional, i.e if the secret does not exist, or the key is not contained in the secret, we ignore the error

.spec.valueFrom[*].secret

stringRequired

Secret is the name of the secret in the configuration namespace

.spec.variables

object

Variables provides the inputs for the terraform module itself. These are passed to the terraform executor and used to execute the plan, apply and destroy phases.

.spec.writeConnectionSecretToRef

object

WriteConnectionSecretToRef is the name for a secret. On execution of the terraform module any module outputs are written to this secret. The outputs are automatically uppercased and ready to be consumed as environment variables. WriteConnectionSecretRef is the secret where the terraform outputs will be written.

.spec.writeConnectionSecretToRef.keys

array

Keys is a collection of name used to filter the terraform output. By default all keys from the output of the terraform state are written to the connection secret. Here we can define exactly which keys we want from that output.

.spec.writeConnectionSecretToRef.keys[*]

string

.spec.writeConnectionSecretToRef.name

stringRequired

Name is the of the secret where you want to the terraform output to be written. The terraform outputs will be written to the secret as a key value pair. All are uppercased can read to be consumed by the workload.

.status

object

ConfigurationStatus defines the observed state of a terraform

.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.costs

object

Costs is the predicted costs of this configuration. Note this field is only populated when the integration has been configured by the administrator.

.status.costs.enabled

boolean

Enabled indicates if the cost integration was enabled when this configuration was last executed.

.status.costs.hourly

string

Hourly is the hourly estimated cost of the configuration

.status.costs.monthly

string

Monthly is the monthly estimated cost of the configuration

.status.driftTimestamp

string

DriftTimestamp is the timestamp of the last drift detection

.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

.status.resourceStatus

string

ResourceStatus indicates the status of the resources and if the resources are insync with the configuration

.status.resources

integer

Resources is the number of managed cloud resources which are currently under management. This field is taken from the terraform state itself.

.status.terraformVersion

string

TerraformVersion is the version of terraform which was last used to run this configuration