common

package
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const ALLOW_DELETE_WHILE_DISCONNECTED_DESCRIPTION = "" /* 222-byte string literal not displayed */
View Source
const AWS_ACCOUNT_ID_DESCRIPTION = "" /* 174-byte string literal not displayed */

AWS descriptions.

View Source
const AWS_BACKUPS_AUTH_DESCRIPTION = "Authentication configuration for backup bucket access"
View Source
const AWS_BACKUPS_BUCKET_DESCRIPTION = "S3 bucket name for backups"
View Source
const AWS_BACKUPS_CUSTOM_BUCKET_DESCRIPTION = "Custom S3 bucket configuration for backups"
View Source
const AWS_BACKUPS_DESCRIPTION = "Configuration for backup storage"
View Source
const AWS_BACKUPS_REGION_DESCRIPTION = "AWS region where the backup bucket is located"
View Source
const AWS_BACKUPS_ROLE_ARN_DESCRIPTION = "IAM role ARN for backup bucket access"
View Source
const AWS_LOAD_BALANCER_CROSS_ZONE_DESCRIPTION = "" /* 129-byte string literal not displayed */
View Source
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"
`
View Source
const AWS_LOAD_BALANCER_ENDPOINT_SERVICE_SUPPORTED_REGIONS_DESCRIPTION = `List of supported regions for VPC endpoints.

		Example: ["us-east-1", "sa-east-1"]
`
View Source
const AWS_NODE_GROUP_NODE_TYPE_DESCRIPTION = `Instance type ([docs](https://aws.amazon.com/ec2/instance-types/))

		Examples:
		- "t4g.large"
`
View Source
const AWS_REGION_DESCRIPTION = `` /* 225-byte string literal not displayed */
View Source
const AWS_RESOURCES_ARN_DESCRIPTION = "AWS resource ARN."
View Source
const AWS_RESOURCES_DESCRIPTION = "AWS resources associated with the environment."
View Source
const AWS_RESOURCES_ID_DESCRIPTION = "AWS resource ID."
View Source
const AWS_RESOURCES_NAME_DESCRIPTION = "AWS resource name."
View Source
const AWS_TAGS_DESCRIPTION = "Tags to apply to AWS resources."
View Source
const AWS_ZONES_DESCRIPTION = `` /* 141-byte string literal not displayed */
View Source
const AZURE_CUSTOM_DOMAIN_DESCRIPTION = `` /* 508-byte string literal not displayed */

Azure descriptions.

View Source
const AZURE_PRIVATE_LINK_SERVICE_ALIAS_DESCRIPTION = "Private Link Service Alias / DNS Name in prefix.GUID.suffix format."
View Source
const AZURE_PRIVATE_LINK_SERVICE_ALLOWED_SUBSCRIPTIONS_DESCRIPTION = "Lists subscription IDs permitted for Private Link access, securing service connections."
View Source
const AZURE_PRIVATE_LINK_SERVICE_DESCRIPTION = "Azure Private Link service configuration."
View Source
const AZURE_REGION_DESCRIPTION = `` /* 165-byte string literal not displayed */
View Source
const AZURE_SUBSCRIPTION_ID_DESCRIPTION = "ID linking the environment to a specific Azure subscription for resource management. **[IMMUTABLE]**"
View Source
const AZURE_TAGS_DESCRIPTION = "Tags to apply to Azure resources."
View Source
const AZURE_TENANT_ID_DESCRIPTION = "ID of the Azure Active Directory tenant for user identity and access management. **[IMMUTABLE]**"
View Source
const AZURE_ZONES_DESCRIPTION = `Explicit list of Azure availability zones. At least 2 required.

		Examples:
		- ["eastus-1", "eastus-2"]
`
View Source
const BUCKET_NAME_DESCRIPTION = "Bucket name"
View Source
const CIDR_DESCRIPTION = `` /* 214-byte string literal not displayed */
View Source
const CLOUD_CONNECT_DESCRIPTION = "" /* 152-byte string literal not displayed */
View Source
const CUSTOM_DOMAIN_DESCRIPTION = `` /* 487-byte string literal not displayed */
View Source
const CUSTOM_NODE_TYPES_CPU_ALLOCATABLE_DESCRIPTION = "Number of allocatable virtual cores"
View Source
const CUSTOM_NODE_TYPES_DESCRIPTION = "Custom node types"
View Source
const CUSTOM_NODE_TYPES_MEMORY_ALLOCATABLE__DESCRIPTION = "Amount of allocatable memory in bytes"
View Source
const CUSTOM_NODE_TYPES_NAME_DESCRIPTION = "Custom node type unique identifier"
View Source
const DISTRIBUTION_DESCRIPTION = `Kubernetes distribution. **[IMMUTABLE]**

		Possible values:
		- "AKS"
		- "EKS"
		- "GKE"
		- "CUSTOM"
`
View Source
const EKS_LOGGING_DESCRIPTION = "Enable/Disable EKS control plane logging to CloudWatch (default `false`)."

EKS Logging descriptions.

View Source
const ENDPOINT_ALIAS_DESCRIPTION = "" /* 175-byte string literal not displayed */
View Source
const ENDPOINT_DESCRIPTION = "AWS environment VPC endpoint configuration"
View Source
const ENDPOINT_PRIVATE_DNS_DESCRIPTION = "`true` indicates whether to associate a private hosted zone with the specified VPC (default `false`)."
View Source
const ENDPOINT_SERVICE_NAME_DESCRIPTION = "VPC endpoint service name in $endpoint_service_id.$region.vpce.amazonaws.com format."
View Source
const EXTERNAL_BUCKET_DESCRIPTION = "List of external S3 bucket to allow access to."
View Source
const EXTERNAL_BUCKET_NAME_DESCRIPTION = "External bucket name."
View Source
const FORCE_DESTROY_CLUSTERS_DESCRIPTION = "" /* 227-byte string literal not displayed */
View Source
const FORCE_DESTROY_DESCRIPTION = "" /* 445-byte string literal not displayed */
View Source
const GCP_NODE_GROUP_NODE_TYPE_DESCRIPTION = `Machine type ([docs](https://cloud.google.com/compute/docs/machine-resource)).

		Examples:
		- "e2-standard-2"
`
View Source
const GCP_PEERING_CONNECTION_DESCRIPTION = "Network peering configuration."
View Source
const GCP_PEERING_CONNECTION_NETWORK_NAME_DESCRIPTION = "Target network name."
View Source
const GCP_PEERING_CONNECTION_PROJECT_ID_DESCRIPTION = "Target network's project ID."
View Source
const GCP_PRIVATE_SERVICE_CONSUMERS_DESCRIPTION = "List of project IDs representing the network's private service consumers."
View Source
const GCP_PROJECT_ID_DESCRIPTION = "" /* 209-byte string literal not displayed */
View Source
const GCP_REGION_DESCRIPTION = `GCP region ([docs](https://cloud.google.com/about/locations)). **[IMMUTABLE]**

		Examples:
		- "us-west1".
`

GCP descriptions.

View Source
const GCP_ZONES_DESCRIPTION = `Explicit list of GCP zones. At least 2 required.
		Examples:
		- ["us-west1-a", "us-west1-b"]
`
View Source
const GCS_STORAGE_DESCRIPTION = "Google Cloud Storage configuration"
View Source
const HCLOUD_LOCATIONS_DESCRIPTION = `Explicit list of HCloud locations. Currently supports single location only.

		Examples:
		- ["hil"]
`
View Source
const HCLOUD_NETWORK_ZONE_DESCRIPTION = `HCloud network ([docs](https://docs.hetzner.com/cloud/general/locations)). **[IMMUTABLE]**

		Examples:
		- "us-west".
`
View Source
const HCLOUD_TOKEN_ENC_DESCRIPTION = "HCloud token (stored encrypted)"

HCloud descriptions.

View Source
const HCLOUD_WIREGUARD_PEERS_ALLOWED_IPS_DESCRIPTION = "A list of addresses (in CIDR notation) that should get routed to the peer."
View Source
const HCLOUD_WIREGUARD_PEERS_DESCRIPTION = "HCloud Wireguard peer configuration."
View Source
const HCLOUD_WIREGUARD_PEERS_ENDPOINT_DESCRIPTION = "Peer endpoint."
View Source
const HCLOUD_WIREGUARD_PEERS_PUBLIC_KEY_DESCRIPTION = "Peer public key."
View Source
const ICEBERG_CATALOGS_DESCRIPTION = "List of Iceberg catalogs."
View Source
const ICEBERG_CATALOG_ANONYMOUS_ACCESS_ENABLED_DESCRIPTION = "Whether anonymous access is enabled (default `false`)."
View Source
const ICEBERG_CATALOG_ASSUME_ROLE_ARN_RO_DESCRIPTION = "IAM role ARN to assume for read-only access."
View Source
const ICEBERG_CATALOG_ASSUME_ROLE_ARN_RW_DESCRIPTION = "IAM role ARN to assume for read-write access."
View Source
const ICEBERG_CATALOG_AWS_REGION_DESCRIPTION = "AWS region for the catalog."
View Source
const ICEBERG_CATALOG_CUSTOM_S3_BUCKET_DESCRIPTION = "Custom S3 bucket name."
View Source
const ICEBERG_CATALOG_CUSTOM_S3_BUCKET_PATH_DESCRIPTION = "Path within the custom S3 bucket."
View Source
const ICEBERG_CATALOG_CUSTOM_S3_TABLE_BUCKET_ARN_DESCRIPTION = "ARN of the S3 Tables bucket."
View Source
const ICEBERG_CATALOG_MAINTENANCE_DESCRIPTION = "Maintenance configuration for the catalog."
View Source
const ICEBERG_CATALOG_MAINTENANCE_ENABLED_DESCRIPTION = "Whether maintenance is enabled (default `true`)."
View Source
const ICEBERG_CATALOG_NAME_DESCRIPTION = "Catalog name. Empty name represents the default catalog."
View Source
const ICEBERG_CATALOG_ROLE_ARN_DESCRIPTION = "IAM role ARN for BYOK environments."
View Source
const ICEBERG_CATALOG_TYPE_DESCRIPTION = `Catalog type.

		Possible values:
		- "S3": S3 bucket-based catalog
		- "S3_TABLE": S3 Tables-based catalog
`
View Source
const ICEBERG_CATALOG_WATCHES_DESCRIPTION = "Table watch configurations."
View Source
const ICEBERG_CATALOG_WATCH_PATHS_DESCRIPTION = "Paths relative to table location to watch."
View Source
const ICEBERG_CATALOG_WATCH_TABLE_DESCRIPTION = "Table name to watch."
View Source
const ICEBERG_DESCRIPTION = "Iceberg configuration for Apache Iceberg table format support."

Iceberg descriptions.

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

Shared descriptions.

View Source
const K8S_LOAD_BALANCER_ANNOTATIONS_DESCRIPTION = "List of annotations for the load balancer"
View Source
const K8S_NODE_GROUP_NODE_TYPE_DESCRIPTION = "node.kubernetes.io/instance-type value."

K8S descriptions.

View Source
const K8S_NODE_GROUP_ZONES_DESCRIPTION = "topology.kubernetes.io/zone values."
View Source
const K8S_REGION_DESCRIPTION = "Cloud provider Region. Check possible available regions in your cloud provider documentation **[IMMUTABLE]**"
View Source
const KEY_DESCRIPTION = "Name of the key"
View Source
const LOAD_BALANCER_DESCRIPTION = "Load balancers configuration."
View Source
const LOAD_BALANCER_ENABLED_DESCRIPTION = "Set to `true` if load balancer is enabled, `false` otherwise. (default `false`)"
View Source
const LOAD_BALANCER_INTERNAL_DESCRIPTION = "Internal load balancer configuration. Accessible via `*.internal.$env_name.altinity.cloud`."
View Source
const LOAD_BALANCER_PUBLIC_DESCRIPTION = "Public load balancer configuration. Accessible via `*.$env_name.altinity.cloud`."
View Source
const LOAD_BALANCING_STRATEGY_DESCRIPTION = `` /* 209-byte string literal not displayed */
View Source
const LOGS_DESCRIPTION = "Kubernetes environment logs configuration"
View Source
const MAINTENANCE_WINDOW_DAYS_DESCRIPTION = `` /* 161-byte string literal not displayed */
View Source
const MAINTENANCE_WINDOW_DESCRIPTION = "" /* 138-byte string literal not displayed */
View Source
const MAINTENANCE_WINDOW_ENABLED_DESCRIPTION = "Set to `true` if maintenance window is enabled, `false` otherwise. (default `false`)"
View Source
const MAINTENANCE_WINDOW_HOUR_DESCRIPTION = "Hour of the day in [0, 23] range."
View Source
const MAINTENANCE_WINDOW_LENGTH_IN_HOURS_DESCRIPTION = "Maintenance window length in hours. 4h min, 24h max."
View Source
const MAINTENANCE_WINDOW_NAME_DESCRIPTION = "Maintenance window identifier"
View Source
const METRICS_DESCRIPTION = "Metrics configuration"
View Source
const METRICS_ENDPOINT_DESCRIPTION = "Metrics endpoint configuration."

Metrics Endpoint descriptions.

View Source
const METRICS_ENDPOINT_ENABLED_DESCRIPTION = "Set to `true` if metrics endpoint is enabled, `false` otherwise (default `false`)."
View Source
const METRICS_ENDPOINT_SOURCE_IP_RANGES_DESCRIPTION = "IP addresses/blocks to allow traffic from when metrics endpoint is enabled."
View Source
const METRICS_RETENTION_PERIOD_IN_DAYS_DESCRIPTION = "Metrics retention period in days (default `30`)."
View Source
const NAME_DESCRIPTION = `` /* 285-byte string literal not displayed */
View Source
const NAT_DESCRIPTION = "Enable AWS NAT Gateway. **[IMMUTABLE]**"
View Source
const NODE_GROUP_CAPACITY_PER_ZONE_DESCRIPTION = "Maximum number of instances per availability zone."
View Source
const NODE_GROUP_DESCRIPTION = "List of node groups. At least one required."
View Source
const NODE_GROUP_NAME_DESCRIPTION = "Unique (among environment node groups) node group identifier."
View Source
const NODE_GROUP_RESERVATIONS_DESCRIPTION = `` /* 219-byte string literal not displayed */
View Source
const NODE_GROUP_SELECTOR_DESCRIPTION = "`nodeSelector` to apply to the pods targeting this group"
View Source
const NODE_GROUP_TOLERATIONS = "List of tolerations to apply to the pods targeting this group"
View Source
const NODE_GROUP_TOLERATIONS_EFFECT = `Node taint effect.

		Possible values:
		- "NO_SCHEDULE"
		- "PREFER_NO_SCHEDULE"
		- "NO_EXECUTE"
`
View Source
const NODE_GROUP_TOLERATIONS_KEY = "Taint key, e.g. 'dedicated'"
View Source
const NODE_GROUP_TOLERATIONS_OPERATOR = `Node toleration operator used to match taints.

		Possible values:
		- "EQUALS"
		- "EXISTS"
`
View Source
const NODE_GROUP_TOLERATIONS_VALUE = "Taint value, e.g. 'clickhouse'"
View Source
const NODE_GROUP_ZONES_DESCRIPTION = "Availability zones. Check possible available zones in your cloud provider documentation"
View Source
const PEERING_CONNECTION_AWS_ACCOUNT_ID_DESCRIPTION = "Target VPC AWS account ID (defaults to environment AWS account ID)."
View Source
const PEERING_CONNECTION_DESCRIPTION = "AWS environment VPC peering configuration."
View Source
const PEERING_CONNECTION_ID_DESCRIPTION = "VPC peering connection ID."
View Source
const PEERING_CONNECTION_VPC_ID_DESCRIPTION = "Target VPC ID."
View Source
const PEERING_CONNECTION_VPC_REGION_DESCRIPTION = "Target VPC region (defaults to environment region)."
View Source
const PERMISSIONS_BOUNDARY_POLICY_ARN_DESCRIPTION = "Policy ARN that sets the maximum permissions for the IAM roles created by the environment. **[IMMUTABLE]**"
View Source
const RESOURCE_PREFIX_DESCRIPTION = "Resource prefix used for provisioned resources **[IMMUTABLE]**"
View Source
const S3_STORAGE_DESCRIPTION = "Amazon S3 configuration"
View Source
const SKIP_PROVISIONING_ON_DESTROY_DESCRIPTION = "" /* 179-byte string literal not displayed */
View Source
const SOURCE_IP_RANGES_DESCRIPTION = " IP addresses/blocks to allow traffic from (default `\"0.0.0.0/0\"`)."
View Source
const STATUS_APPLIED_SPEC_REVISION_DESCRIPTION = "Applied spec revision"
View Source
const STATUS_DESCRIPTION = "Environment status"
View Source
const STATUS_LOAD_BALANCERS_DESCRIPTION = "Load balancer status information."
View Source
const STATUS_LOAD_BALANCERS_ENDPOINT_SERVICE_NAME_DESCRIPTION = "VPC endpoint service name in $endpoint_service_id.$region.vpce.amazonaws.com format (if any)"
View Source
const STATUS_LOAD_BALANCERS_INTERNAL_DESCRIPTION = "Status of internal load balancer."
View Source
const STATUS_PENDING_DELETE_DESCRIPTION = "`true` indicates that environment is pending deletion"
View Source
const STATUS_SPEC_REVISION_DESCRIPTION = "Spec revision"
View Source
const STATUS_WAIT_FOR_APPLIED_SPEC_REVISION_DESCRIPTION = "" /* 152-byte string literal not displayed */
View Source
const STORAGE_DESCRIPTION = "Storage backend configuration"
View Source
const VALUE_DESCRIPTION = "Value of the key"
View Source
const VERBOSE_DESCRIPTION = "" /* 136-byte string literal not displayed */

Status verbose descriptions.

Variables

View Source
var AppliedSpecRevisionAttribute = rschema.Int64Attribute{
	Computed:            true,
	MarkdownDescription: STATUS_APPLIED_SPEC_REVISION_DESCRIPTION,
}
View Source
var DomainRegex = regexp.MustCompile("^[a-z0-9][a-z0-9-]{0,63}([.][a-z0-9][a-z0-9-]{0,63})+$")
View Source
var EnabledAttribute = rschema.BoolAttribute{
	Optional:            true,
	Computed:            true,
	MarkdownDescription: LOAD_BALANCER_ENABLED_DESCRIPTION,
	Default:             booldefault.StaticBool(false),
}
View Source
var IDAttribute = rschema.StringAttribute{
	Computed:            true,
	MarkdownDescription: ID_DESCRIPTION,
	PlanModifiers: []planmodifier.String{
		stringplanmodifier.UseStateForUnknown(),
	},
}
View Source
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,
		},
	},
}
View Source
var NameAttribute = rschema.StringAttribute{
	Required:            true,
	MarkdownDescription: NAME_DESCRIPTION,
	PlanModifiers: []planmodifier.String{
		stringplanmodifier.RequiresReplace(),
	},
}
View Source
var NodeGroupAttribute = rschema.NestedAttributeObject{
	Attributes: map[string]rschema.Attribute{
		"name": rschema.StringAttribute{
			Optional:            true,
			Computed:            true,
			MarkdownDescription: NODE_GROUP_NAME_DESCRIPTION,
			Validators: []validator.String{
				stringvalidator.LengthAtLeast(1),
			},
		},
		"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),
	},
}
View Source
var PendingDeleteAttribute = rschema.BoolAttribute{
	Required:            false,
	Optional:            false,
	Computed:            true,
	MarkdownDescription: STATUS_PENDING_DELETE_DESCRIPTION,
}
View Source
var SourceIPRangesAttribute = rschema.ListAttribute{
	ElementType:         types.StringType,
	Optional:            true,
	MarkdownDescription: SOURCE_IP_RANGES_DESCRIPTION,
	Validators: []validator.List{
		listvalidator.SizeAtLeast(1),
		listvalidator.ValueStringsAre(
			validators.CIDR(),
		),
	},
}
View Source
var SpecRevisionAttribute = rschema.Int64Attribute{
	Computed:            true,
	MarkdownDescription: STATUS_SPEC_REVISION_DESCRIPTION,
}
View Source
var VerboseAttribute = rschema.BoolAttribute{
	Optional:            true,
	Computed:            true,
	MarkdownDescription: VERBOSE_DESCRIPTION,
	Default:             booldefault.StaticBool(true),
}
View Source
var WaitForAppliedSpecRevisionAttribute = rschema.Int64Attribute{
	Optional:            true,
	MarkdownDescription: STATUS_WAIT_FOR_APPLIED_SPEC_REVISION_DESCRIPTION,
}

Functions

func GetAllowDeleteWhileDisconnectedAttribute added in v0.4.6

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

func GetCIDRAttribute

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

func GetCommonCustomDomainAttribute added in v0.2.1

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 added in v0.1.2

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 GetMetricsEndpointAttribute added in v0.5.0

func GetMetricsEndpointAttribute(required, optional, computed bool) rschema.SingleNestedAttribute

func GetNodeGroupsAttribute added in v0.4.0

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

func GetRegionAttribute added in v0.4.0

func GetRegionAttribute(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 added in v0.2.0

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

func GetZonesAttribute

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

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL