api-docs.md

API Reference

Packages

• api.localstack.cloud/v1alpha1

api.localstack.cloud/v1alpha1

Package v1alpha1 contains API Schema definitions for the api v1alpha1 API group

Resource Types

• LocalStack
• LocalStackList

CaCertificate

CaCertificate provides options for providing a custom CA certificate for outbound requests

Appears in:

• LicenseServerConfig

Field	Description	Default	Validation
configMap CaCertificateConfigMap			Optional: {}

CaCertificateConfigMap

Appears in:

• CaCertificate

Field	Description	Default	Validation
name string			Optional: {}
namespace string			Optional: {}
key string			Optional: {}

Hooks

Appears in:

• LocalStackSpec

Field	Description	Default	Validation
readyConfigName string			Optional: {}
bootConfigName string			Optional: {}
shutdownConfigName string			Optional: {}
startConfigName string			Optional: {}

LicenseServerConfig

Appears in:

• LocalStackSpec

Field	Description	Default	Validation
proxies object (keys:string, values:string)		{ }	Optional: {}
endpoint string		https://api.localstack.cloud/v1	Required: {}
caCertificate CaCertificate			Optional: {}

LocalStack

LocalStack is the Schema for the localstacks API

Appears in:

• LocalStackList

Field	Description	Default	Validation
apiVersion string	api.localstack.cloud/v1alpha1
kind string	LocalStack
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		Optional: {}
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		Optional: {}
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec LocalStackSpec
status LocalStackStatus

LocalStackList

LocalStackList contains a list of LocalStack

Field	Description	Default	Validation
apiVersion string	api.localstack.cloud/v1alpha1
kind string	LocalStackList
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		Optional: {}
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		Optional: {}
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items LocalStack array

LocalStackSpec

LocalStackSpec defines the desired state of LocalStack

Appears in:

• LocalStack

Field	Description	Default	Validation
dnsProvider string			Enum: [none coredns] Required: {}
dnsConfigName string			Required: {}
dnsConfigNamespace string			Required: {}
debug string		info	Enum: [trace trace-internal debug info warn error warning] Optional: {}
autoLoadPods string array			Optional: {}
authToken string			MaxLength: 39 MinLength: 39 Optional: {} Pattern: ^ls-[a-zA-Z0-9]\{8\}-[a-zA-Z0-9]\{4\}-[a-zA-Z0-9]\{4\}-[a-zA-Z0-9]\{4\}-[a-zA-Z0-9]\{12\}$
pvcName string	Mount a PVC at /var/lib/localstack providing caching between LocalStack lifetimes		Optional: {}
hooks Hooks			Optional: {}
licenseServerConfig LicenseServerConfig		{ endpoint:https://api.localstack.cloud/v1 }	Optional: {}
image string	Validate docker inage name (with optional tag and registry address)		Pattern: (?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)?(?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)*[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*(:[a-zA-Z0-9_.-]+)? Required: {}
imagePullPolicy PullPolicy	PullPolicy describes a policy for if/when to pull a container image. If providing an image tag of "latest", the default will be set to "Always", otherwise "IfNotPresent"		Enum: [Always IfNotPresent Never] Optional: {}
resources ResourceRequirements			Optional: {}
readiness_probe Probe			Optional: {}
liveness_probe Probe			Optional: {}
envFrom EnvFromSource array			Optional: {}
env EnvVar array			Optional: {}
dnsPolicy DNSPolicy		ClusterFirst	Enum: [Default ClusterFirst ClusterFirstWithHostNet None] Optional: {}
runAsUser integer		0	Enum: [0 1000] Optional: {}
podSecurityContext PodSecurityContext			Optional: {}
containerSecurityContext SecurityContext			Optional: {}

LocalStackStatus

LocalStackStatus defines the observed state of LocalStack

Appears in:

• LocalStack

Field	Description	Default	Validation
ready boolean
ip string
dns string

PodSpec

Appears in:

• LocalStackSpec

Field	Description	Default	Validation
image string	Validate docker inage name (with optional tag and registry address)		Pattern: (?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)?(?:[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*\/)*[a-zA-Z0-9]+(?:[._-][a-zA-Z0-9]+)*(:[a-zA-Z0-9_.-]+)? Required: {}
imagePullPolicy PullPolicy	PullPolicy describes a policy for if/when to pull a container image. If providing an image tag of "latest", the default will be set to "Always", otherwise "IfNotPresent"		Enum: [Always IfNotPresent Never] Optional: {}
resources ResourceRequirements			Optional: {}
readiness_probe Probe			Optional: {}
liveness_probe Probe			Optional: {}
envFrom EnvFromSource array			Optional: {}
env EnvVar array			Optional: {}
dnsPolicy DNSPolicy		ClusterFirst	Enum: [Default ClusterFirst ClusterFirstWithHostNet None] Optional: {}
runAsUser integer		0	Enum: [0 1000] Optional: {}
podSecurityContext PodSecurityContext			Optional: {}
containerSecurityContext SecurityContext			Optional: {}