common

Documentation

Index

• Constants
• Variables
• func GetCIDRAttribute(required, optional, computed bool) rschema.StringAttribute
• func GetCommonCustomDomainAttribute(required, optional, computed bool) rschema.StringAttribute
• func GetCustomDomainAttribute(required, optional, computed bool, description string) rschema.StringAttribute
• func GetForceDestroyAttribute(required, optional, computed bool) rschema.BoolAttribute
• func GetForceDestroyClustersAttribute(required, optional, computed bool) rschema.BoolAttribute
• func GetLoadBalancingStrategyAttribute(required, optional, computed bool) rschema.StringAttribute
• func GetMaintenanceWindowAttribute(required, optional, computed bool) rschema.ListNestedAttribute
• func GetNodeGroupsAttribure(required, optional, computed bool) rschema.SetNestedAttribute
• func GetNumberOfZonesAttribute(required, optional, computed bool) rschema.Int64Attribute
• func GetRegionAttribure(required, optional, computed bool, description string) rschema.StringAttribute
• func GetReservationsAttribute(required, optional, computed bool) rschema.SetAttribute
• func GetSkipProvisioningOnDestroyAttribute(required, optional, computed bool) rschema.BoolAttribute
• func GetTagsAttribute(required, optional, computed bool, description string) rschema.ListNestedAttribute
• func GetZonesAttribute(required, optional, computed bool, description string) rschema.ListAttribute

Constants

const AWS_ACCOUNT_ID_DESCRIPTION = "" /* 174-byte string literal not displayed */

AWS descriptions.

const AWS_LOAD_BALANCER_CROSS_ZONE_DESCRIPTION = "" /* 129-byte string literal not displayed */

const AWS_LOAD_BALANCER_ENDPOINT_SERVICE_ALLOWED_PRINCIPALS_DESCRIPTION = `ARNs for AWS principals that are allowed to create VPC endpoints.

		Examples:
		- "arn:aws:iam::$account_id:root"
`

const AWS_NODE_GROUP_NODE_TYPE_DESCRIPTION = `Instance type ([docs](https://aws.amazon.com/ec2/instance-types/))

		Examples:
		- "t4g.large"
`

const AWS_REGION_DESCRIPTION = `` /* 225-byte string literal not displayed */

const AWS_TAGS_DESCRIPTION = "Tags to apply to AWS resources."

const AWS_ZONES_DESCRIPTION = `` /* 141-byte string literal not displayed */

const AZURE_CUSTOM_DOMAIN_DESCRIPTION = `` /* 508-byte string literal not displayed */

Azure descriptions.

const AZURE_PRIVATE_LINK_SERVICE_ALIAS_DESCRIPTION = "Private Link Service Alias / DNS Name in prefix.GUID.suffix format."

const AZURE_PRIVATE_LINK_SERVICE_ALLOWED_SUBSCRIPTIONS_DESCRIPTION = "Lists subscription IDs permitted for Private Link access, securing service connections."

const AZURE_PRIVATE_LINK_SERVICE_DESCRIPTION = "Azure Private Link service configuration."

const AZURE_REGION_DESCRIPTION = `` /* 165-byte string literal not displayed */

const AZURE_SUBSCRIPTION_ID_DESCRIPTION = "ID linking the environment to a specific Azure subscription for resource management. **[IMMUTABLE]**"

const AZURE_TAGS_DESCRIPTION = "Tags to apply to Azure resources."

const AZURE_TENANT_ID_DESCRIPTION = "ID of the Azure Active Directory tenant for user identity and access management. **[IMMUTABLE]**"

const AZURE_ZONES_DESCRIPTION = `Explicit list of Azure availability zones. At least 2 required.

		Examples:
		- ["eastus-1", "eastus-2"]
`

const BUCKET_NAME_DESCRIPTION = "Bucket name"

const CIDR_DESCRIPTION = `` /* 214-byte string literal not displayed */

const CLOUD_CONNECT_DESCRIPTION = "" /* 152-byte string literal not displayed */

const CUSTOM_DOMAIN_DESCRIPTION = `` /* 487-byte string literal not displayed */

const CUSTOM_NODE_TYPES_CPU_ALLOCATABLE_DESCRIPTION = "Number of allocatable virtual cores"

const CUSTOM_NODE_TYPES_DESCRIPTION = "Custom node types"

const CUSTOM_NODE_TYPES_MEMORY_ALLOCATABLE__DESCRIPTION = "Amount of allocatable memory in bytes"

const CUSTOM_NODE_TYPES_NAME_DESCRIPTION = "Custom node type unique identifier"

const DISTRIBUTION_DESCRIPTION = `Kubernetes distribution. **[IMMUTABLE]**

		Possible values:
		- "AKS"
		- "EKS"
		- "GKE"
		- "CUSTOM"
`

const ENDPOINT_ALIAS_DESCRIPTION = "" /* 175-byte string literal not displayed */

const ENDPOINT_DESCRIPTION = "AWS environment VPC endpoint configuration"

const ENDPOINT_SERVICE_NAME_DESCRIPTION = "VPC endpoint service name in $endpoint_service_id.$region.vpce.amazonaws.com format."

const FORCE_DESTROY_CLUSTERS_DESCRIPTION = "" /* 227-byte string literal not displayed */

const FORCE_DESTROY_DESCRIPTION = "" /* 447-byte string literal not displayed */

const GCP_NODE_GROUP_NODE_TYPE_DESCRIPTION = `Machine type ([docs](https://cloud.google.com/compute/docs/machine-resource)).

		Examples:
		- "e2-standard-2"
`

const GCP_PROJECT_ID_DESCRIPTION = "" /* 209-byte string literal not displayed */

const GCP_REGION_DESCRIPTION = `GCP region ([docs](https://cloud.google.com/about/locations)). **[IMMUTABLE]**

		Examples:
		- "us-west1".
`

GCP descriptions.

const GCP_ZONES_DESCRIPTION = `Explicit list of GCP zones. At least 2 required.
		Examples:
		- ["us-west1a", "us-west1b"]
`

const GCS_STORAGE_DESCRIPTION = "Google Cloud Storage configuration"

const ID_DESCRIPTION = "ID of the environment (automatically generated based on the name)"

Shared descriptions.

const K8S_LOAD_BALANCER_ANNOTATIONS_DESCRIPTION = "List of annotations for the load balancer"

const K8S_NODE_GROUP_NODE_TYPE_DESCRIPTION = "node.kubernetes.io/instance-type value."

K8S descriptions.

const K8S_NODE_GROUP_ZONES_DESCRIPTION = "topology.kubernetes.io/zone values."

const K8S_REGION_DESCRIPTION = "Cloud provider Region. Check possible available regions in your cloud provider documentation **[IMMUTABLE]**"

const KEY_DESCRIPTION = "Name of the key"

const LOAD_BALANCER_DESCRIPTION = "Load balancers configuration."

const LOAD_BALANCER_ENABLED_DESCRIPTION = "Set to `true` if load balancer is enabled, `false` otherwise. (default `false`)"

const LOAD_BALANCER_INTERNAL_DESCRIPTION = "Internal load balancer configuration. Accessible via `*.internal.$env_name.altinity.cloud`."

const LOAD_BALANCER_PUBLIC_DESCRIPTION = "Public load balancer configuration. Accessible via `*.$env_name.altinity.cloud`."

const LOAD_BALANCING_STRATEGY_DESCRIPTION = `` /* 209-byte string literal not displayed */

const LOGS_DESCRIPTION = "Kubernetes environment logs configuration"

const MAINTENANCE_WINDOW_DAYS_DESCRIPTION = `` /* 161-byte string literal not displayed */

const MAINTENANCE_WINDOW_DESCRIPTION = "" /* 138-byte string literal not displayed */

const MAINTENANCE_WINDOW_ENABLED_DESCRIPTION = "Set to `true` if maintenance window is enabled, `false` otherwise. (default `false`)"

const MAINTENANCE_WINDOW_HOUR_DESCRIPTION = "Hour of the day in [0, 23] range."

const MAINTENANCE_WINDOW_LENGTH_IN_HOURS_DESCRIPTION = "Maintenance window length in hours. 4h min, 24h max."

const MAINTENANCE_WINDOW_NAME_DESCRIPTION = "Maintenance window identifier"

const METRICS_DESCRIPTION = "Metrics configuration"

const METRICS_RETENTION_PERIOD_IN_DAYS_DESCRIPTION = "Metrics retention period in days (default `30`)."

const NAME_DESCRIPTION = `` /* 193-byte string literal not displayed */

const NODE_GROUP_CAPACITY_PER_ZONE_DESCRIPTION = "Maximum number of instances per availability zone."

const NODE_GROUP_DESCRIPTION = "List of node groups. At least one required."

const NODE_GROUP_NAME_DESCRIPTION = "Unique (among environment node groups) node group identifier."

const NODE_GROUP_RESERVATIONS_DESCRIPTION = `` /* 219-byte string literal not displayed */

const NODE_GROUP_SELECTOR_DESCRIPTION = "`nodeSelector` to apply to the pods targeting this group"

const NODE_GROUP_TOLERATIONS = "List of tolerations to apply to the pods targeting this group"

const NODE_GROUP_TOLERATIONS_EFFECT = `Node taint effect.

		Possible values:
		- "NO_SCHEDULE"
		- "PREFER_NO_SCHEDULE"
		- "NO_EXECUTE"
`

const NODE_GROUP_TOLERATIONS_KEY = "Taint key, e.g. 'dedicated'"

const NODE_GROUP_TOLERATIONS_OPERATOR = `Node toleration operator used to match taints.

		Possible values:
		- "EQUALS"
		- "EXISTS"
`

const NODE_GROUP_TOLERATIONS_VALUE = "Taint value, e.g. 'clickhouse'"

const NODE_GROUP_ZONES_DESCRIPTION = "Availability zones. Check possible available zones in your cloud provider documentation"

const NUMBER_OF_ZONES_DESCRIPTION = "" /* 163-byte string literal not displayed */

const PEERING_CONNECTION_AWS_ACCOUNT_ID_DESCRIPTION = "Target VPC AWS account ID (defaults to environment AWS account ID)."

const PEERING_CONNECTION_DESCRIPTION = "AWS environment VPC peering configuration."

const PEERING_CONNECTION_ID_DESCRIPTION = "VPC peering connection ID."

const PEERING_CONNECTION_VPC_ID_DESCRIPTION = "Target VPC ID."

const PEERING_CONNECTION_VPC_REGION_DESCRIPTION = "Target VPC region (defaults to environment region)."

const S3_STORAGE_DESCRIPTION = "Amazon S3 configuration"

const SKIP_DEPROVISION_ON_DESTROY_DESCRIPTION = "Set to `true` will delete without waiting for environment deprovisioning. Use this with precaution (default `false`)."

const SOURCE_IP_RANGES_DESCRIPTION = " IP addresses/blocks to allow traffic from (default `\"0.0.0.0/0\"`)."

const STATUS_APPLIED_SPEC_REVISION_DESCRIPTION = "Applied spec revision"

const STATUS_DESCRIPTION = "Environment status"

const STATUS_LOAD_BALANCERS_DESCRIPTION = "Status of internal load balancer."

const STATUS_LOAD_BALANCERS_ENDPOINT_SERVICE_NAME_DESCRIPTION = "VPC endpoint service name in $endpoint_service_id.$region.vpce.amazonaws.com format (if any)"

const STATUS_LOAD_BALANCERS_INTERNAL_DESCRIPTION = "Status of load balancers."

const STATUS_PENDING_DELETE_DESCRIPTION = "`true` indicates that environment is pending deletion"

const STATUS_SPEC_REVISION_DESCRIPTION = "Spec revision"

const STORAGE_DESCRIPTION = "Storage backend configuration"

const VALUE_DESCRIPTION = "Value of the key"

Variables

var AppliedSpecRevisionAttribute = rschema.Int64Attribute{
	Computed:            true,
	MarkdownDescription: STATUS_APPLIED_SPEC_REVISION_DESCRIPTION,
}

var CIDR_REGEX = regexp.MustCompile(`^([0-9]{1,3}\.){3}[0-9]{1,3}\/[0-9]{1,2}$`)

var DOMAIN_REGEX = regexp.MustCompile("^[a-z0-9][a-z0-9-]{0,63}([.][a-z0-9][a-z0-9-]{0,63})+$")

var EnabledAttribute = rschema.BoolAttribute{
	Optional:            true,
	Computed:            true,
	MarkdownDescription: LOAD_BALANCER_ENABLED_DESCRIPTION,
	Default:             booldefault.StaticBool(false),
}

var IDAttribute = rschema.StringAttribute{
	Computed:            true,
	MarkdownDescription: ID_DESCRIPTION,
	PlanModifiers: []planmodifier.String{
		stringplanmodifier.UseStateForUnknown(),
	},
}

var KeyValueAttribute = rschema.NestedAttributeObject{
	Attributes: map[string]rschema.Attribute{
		"key": rschema.StringAttribute{
			Required:            true,
			MarkdownDescription: KEY_DESCRIPTION,
		},
		"value": rschema.StringAttribute{
			Required:            true,
			MarkdownDescription: VALUE_DESCRIPTION,
		},
	},
}

var NameAttribute = rschema.StringAttribute{
	Required:            true,
	MarkdownDescription: NAME_DESCRIPTION,
	PlanModifiers: []planmodifier.String{
		stringplanmodifier.RequiresReplace(),
	},
}

var NodeGroupAttribute = rschema.NestedAttributeObject{
	Attributes: map[string]rschema.Attribute{
		"name": rschema.StringAttribute{
			Optional:            true,
			Computed:            true,
			MarkdownDescription: NODE_GROUP_NAME_DESCRIPTION,
		},
		"node_type": rschema.StringAttribute{
			Required:            true,
			MarkdownDescription: NODE_GROUP_DESCRIPTION,
		},
		"capacity_per_zone": rschema.Int64Attribute{
			Required:            true,
			MarkdownDescription: NODE_GROUP_CAPACITY_PER_ZONE_DESCRIPTION,
			Validators: []validator.Int64{
				int64validator.AtLeast(1),
			},
		},
		"zones": rschema.ListAttribute{
			ElementType:         types.StringType,
			Optional:            true,
			Computed:            true,
			MarkdownDescription: NODE_GROUP_ZONES_DESCRIPTION,
			Validators: []validator.List{
				listvalidator.SizeAtLeast(1),
			},
		},
		"reservations": GetReservationsAttribute(true, false, false),
	},
}

var PendingDeleteAttribute = rschema.BoolAttribute{
	Required:            false,
	Optional:            false,
	Computed:            true,
	MarkdownDescription: STATUS_PENDING_DELETE_DESCRIPTION,
}

var SourceIPRangesAttribute = rschema.ListAttribute{
	ElementType:         types.StringType,
	Optional:            true,
	MarkdownDescription: SOURCE_IP_RANGES_DESCRIPTION,
	Validators: []validator.List{
		listvalidator.SizeAtLeast(1),
		listvalidator.ValueStringsAre(
			stringvalidator.RegexMatches(CIDR_REGEX, "invalid CIDR (expecting something like 1.2.3.4/32)"),
		),
	},
}

var SpecRevisionAttribute = rschema.Int64Attribute{
	Computed:            true,
	MarkdownDescription: STATUS_SPEC_REVISION_DESCRIPTION,
}

var WaitForAppliedSpecRevisionAttribute = rschema.Int64Attribute{
	Optional:            true,
	MarkdownDescription: STATUS_APPLIED_SPEC_REVISION_DESCRIPTION,
}

Functions

func GetCIDRAttribute

func GetCIDRAttribute(required, optional, computed bool) rschema.StringAttribute

func GetCommonCustomDomainAttribute

func GetCommonCustomDomainAttribute(required, optional, computed bool) rschema.StringAttribute

func GetCustomDomainAttribute

func GetCustomDomainAttribute(required, optional, computed bool, description string) rschema.StringAttribute

func GetForceDestroyAttribute

func GetForceDestroyAttribute(required, optional, computed bool) rschema.BoolAttribute

func GetForceDestroyClustersAttribute

func GetForceDestroyClustersAttribute(required, optional, computed bool) rschema.BoolAttribute

func GetLoadBalancingStrategyAttribute

func GetLoadBalancingStrategyAttribute(required, optional, computed bool) rschema.StringAttribute

func GetMaintenanceWindowAttribute

func GetMaintenanceWindowAttribute(required, optional, computed bool) rschema.ListNestedAttribute

func GetNodeGroupsAttribure

func GetNodeGroupsAttribure(required, optional, computed bool) rschema.SetNestedAttribute

func GetNumberOfZonesAttribute

func GetNumberOfZonesAttribute(required, optional, computed bool) rschema.Int64Attribute

func GetRegionAttribure

func GetRegionAttribure(required, optional, computed bool, description string) rschema.StringAttribute

func GetReservationsAttribute

func GetReservationsAttribute(required, optional, computed bool) rschema.SetAttribute

func GetSkipProvisioningOnDestroyAttribute

func GetSkipProvisioningOnDestroyAttribute(required, optional, computed bool) rschema.BoolAttribute

func GetTagsAttribute

func GetTagsAttribute(required, optional, computed bool, description string) rschema.ListNestedAttribute

func GetZonesAttribute

func GetZonesAttribute(required, optional, computed bool, description string) rschema.ListAttribute