Tarmak



Config v1alpha1

Group Version Kind
tarmak v1alpha1 Config
Field Description
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/api-conventions.md#resources
clusters
Cluster array
contact
string
currentCluster
string
environments
Environment array
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/api-conventions.md#types-kinds
metadata
ObjectMeta
project
string
providers
Provider array

Image v1alpha1

Group Version Kind
tarmak v1alpha1 Image
Field Description
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/api-conventions.md#resources
baseImage
string
encrypted
boolean
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/api-conventions.md#types-kinds
location
string
metadata
ObjectMeta

Flags v1alpha1

Group Version Kind
tarmak v1alpha1 Flags

This represents tarmaks global flags

Field Description
cluster
ClusterFlags
configDirectory
string
logrus log level to run with
currentCluster
string
initialize
boolean
keepContainers
boolean
path to config directory
verbose
boolean
version
string
wingDevMode
boolean

Cluster v1alpha1

Group Version Kind
cluster v1alpha1 Cluster
Field Description
amazon
ClusterAmazon
Amazon specific options
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/api-conventions.md#resources
cloud
string
cloudId
string
environment
string
groupIdentifier
string
instancePools
InstancePool array
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/api-conventions.md#types-kinds
kubernetes
ClusterKubernetes
kubernetesAPI
KubernetesAPI
location
string
loggingSinks
LoggingSink array
metadata
ObjectMeta
network
Network
values
Values

Instance v1alpha1

Group Version Kind
wing v1alpha1 Instance
Field Description
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/api-conventions.md#resources
instanceID
string
instancePool
string
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/api-conventions.md#types-kinds
metadata
ObjectMeta
spec
InstanceSpec
status
InstanceStatus

InstanceSpec v1alpha1

Field Description
converge
InstanceSpecManifest
dryRun
InstanceSpecManifest

InstanceStatus v1alpha1

Field Description
converge
InstanceStatusManifest
dryRun
InstanceStatusManifest

Old API Versions


Field Definitions


AmazonESProxy v1alpha1

Group Version Kind
cluster v1alpha1 AmazonESProxy
Field Description
port
integer

ClusterAmazon v1alpha1

Group Version Kind
cluster v1alpha1 ClusterAmazon

ClusterAmazon offers Amazon-specific settings for that instance pool

Field Description
additionalIAMPolicies
string array
This fields contains ARNs for additional IAM policies to be added to this instance pool
ebsEncrypted
boolean
When set to true, AWS Elastic Block Storage volumes are encrypted

ClusterApplyFlags v1alpha1

Group Version Kind
tarmak v1alpha1 ClusterApplyFlags

Contains the cluster apply flags

Field Description
autoApprove
boolean
autoApproveDeletingData
boolean
auto approve apply queries
configurationOnly
boolean
dryRun
boolean
infrastructureOnly
boolean
planFileLocation
string

ClusterDestroyFlags v1alpha1

Group Version Kind
tarmak v1alpha1 ClusterDestroyFlags

Contains the cluster destroy flags

Field Description
dryRun
boolean

ClusterFlags v1alpha1

Group Version Kind
tarmak v1alpha1 ClusterFlags

This contains the cluster specifc operation flags

Field Description
apply
ClusterApplyFlags
destroy
ClusterDestroyFlags
flags for applying clusters
images
ClusterImagesFlags
flags for destroying clusters
plan
ClusterPlanFlags
flags for handling images

ClusterImagesBuildFlags v1alpha1

Group Version Kind
tarmak v1alpha1 ClusterImagesBuildFlags

Contains the cluster images build flags

Field Description
rebuildExisting
boolean

ClusterImagesFlags v1alpha1

Group Version Kind
tarmak v1alpha1 ClusterImagesFlags

Contains the cluster images flags

Field Description
build
ClusterImagesBuildFlags

ClusterKubernetes v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetes
Field Description
apiServer
ClusterKubernetesAPIServer
clusterAutoscaler
ClusterKubernetesClusterAutoscaler
dashboard
ClusterKubernetesDashboard
podCIDR
string
podSecurityPolicy
ClusterPodSecurityPolicy
prometheus
ClusterKubernetesPrometheus
serviceCIDR
string
tiller
ClusterKubernetesTiller
version
string
zone
string

ClusterKubernetesAPIServer v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesAPIServer
Field Description
allowCIDRs
string array
amazon
ClusterKubernetesAPIServerAmazon
AWS specifc options
disableAdmissionControllers
string array
enableAdmissionControllers
string array
oidc
ClusterKubernetesAPIServerOIDC
OIDC
public
boolean
expose the API server through a public load balancer

ClusterKubernetesAPIServerAmazon v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesAPIServerAmazon
Field Description
internalELBAccessLogs
ClusterKubernetesAPIServerAmazonAccessLogs
publicELBAccessLogs
ClusterKubernetesAPIServerAmazonAccessLogs

ClusterKubernetesAPIServerAmazonAccessLogs v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesAPIServerAmazonAccessLogs
Field Description
bucket
string
bucketPrefix
string
enabled
boolean
interval
integer

ClusterKubernetesAPIServerOIDC v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesAPIServerOIDC
Field Description
clientID
string
The client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
groupsClaim
string
If provided, the name of a custom OpenID Connect claim for specifying user groups. The claim value is expected to be a string or array of strings. This flag is experimental, please see the authentication documentation for further details.
groupsPrefix
string
If provided, all groups will be prefixed with this value to prevent conflicts with other authentication strategies.
issuerURL
string
The URL of the OpenID issuer, only HTTPS scheme will be accepted. If set, it will be used to verify the OIDC JSON Web Token (JWT).
signingAlgs
string array
Comma-separated list of allowed JOSE asymmetric signing algorithms. JWTs with a 'alg' header value not in this list will be rejected. Values are defined by RFC 7518 https://tools.ietf.org/html/rfc7518#section-3.1. (default [RS256])
usernameClaim
string
The OpenID claim to use as the user name. Note that claims other than the default ('sub') is not guaranteed to be unique and immutable. This flag is experimental, please see the authentication documentation for further details. (default "sub")
usernamePrefix
string
If provided, all usernames will be prefixed with this value. If not provided, username claims other than 'email' are prefixed by the issuer URL to avoid clashes. To skip any prefixing, provide the value '-'.

ClusterKubernetesClusterAutoscaler v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesClusterAutoscaler
Field Description
enabled
boolean
image
string
overprovisioning
ClusterKubernetesClusterAutoscalerOverprovisioning
scaleDownUtilizationThreshold
number
version
string

ClusterKubernetesClusterAutoscalerOverprovisioning v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesClusterAutoscalerOverprovisioning
Field Description
coresPerReplica
integer
enabled
boolean
image
string
nodesPerReplica
integer
replicaCount
integer
reservedMegabytesPerReplica
integer
reservedMillicoresPerReplica
integer
version
string

ClusterKubernetesDashboard v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesDashboard
Field Description
enabled
boolean
image
string
version
string

ClusterKubernetesPrometheus v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesPrometheus

Configure the cluster internal deployment of prometheus

Field Description
enabled
boolean
Enable a cluster internal prometheus deployment, default: true
mode
string
Mode defines which components are installed

ClusterKubernetesTiller v1alpha1

Group Version Kind
cluster v1alpha1 ClusterKubernetesTiller
Field Description
enabled
boolean
image
string
version
string

ClusterPlanFlags v1alpha1

Group Version Kind
tarmak v1alpha1 ClusterPlanFlags

Contains the cluster plan flags

Field Description
planFileStore
string

ClusterPodSecurityPolicy v1alpha1

Group Version Kind
cluster v1alpha1 ClusterPodSecurityPolicy
Field Description
enabled
boolean

EgressRule v1alpha1

Group Version Kind
cluster v1alpha1 EgressRule

EgressRule parameters for the firewall

Field Description
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/api-conventions.md#resources
egressDestination
string
this thing should be a string.
egressProtocol
string
egressToPort
string
identifier
string
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/api-conventions.md#types-kinds
metadata
ObjectMeta

Environment v1alpha1

Group Version Kind
tarmak v1alpha1 Environment
Field Description
adminCIDRs
string array
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/api-conventions.md#resources
contact
string
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/api-conventions.md#types-kinds
location
string
metadata
ObjectMeta
privateZone
string
project
string
provider
string
ssh
SSH

Firewall v1alpha1

Group Version Kind
cluster v1alpha1 Firewall

Firewall contains the configuration a user expects to be applied.

Field Description
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/api-conventions.md#resources
egressRules
EgressRule array
identifier
string
ingressRules
IngressRule array
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/api-conventions.md#types-kinds
metadata
ObjectMeta

HTTPBasicAuth v1alpha1

Group Version Kind
cluster v1alpha1 HTTPBasicAuth
Field Description
password
string
username
string

IngressRule v1alpha1

Group Version Kind
cluster v1alpha1 IngressRule

IngressRule parameters for the firewall

Field Description
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/api-conventions.md#resources
identifier
string
ingressFromPort
string
ingressProtocol
string
ingressSource
string
this thing should be a string.
ingressToPort
string
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/api-conventions.md#types-kinds
metadata
ObjectMeta

InstancePool v1alpha1

Group Version Kind
cluster v1alpha1 InstancePool
Field Description
allowCIDRs
string array
amazon
InstancePoolAmazon
Amazon specific settings for that instance pool
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/api-conventions.md#resources
bootstrapScripts
string array
firewalls
Firewall array
identifier
string
image
string
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/api-conventions.md#types-kinds
kubernetes
InstancePoolKubernetes
labels
Label array
maxCount
integer
metadata
ObjectMeta
minCount
integer
size
string
spotPrice
string
subnets
Subnet array
taints
Taint array
type
string
volumes
Volume array

InstancePoolAmazon v1alpha1

Group Version Kind
cluster v1alpha1 InstancePoolAmazon

Amazon specific settings for that instance pool

Field Description
additionalIAMPolicies
string array
This fields contains ARNs for additional IAM policies to be added to this instance pool

InstancePoolKubernetes v1alpha1

Group Version Kind
cluster v1alpha1 InstancePoolKubernetes
Field Description
version
string

InstanceSpecManifest v1alpha1

Group Version Kind
wing v1alpha1 InstanceSpecManifest

InstaceSpecManifest defines location and hash for a specific manifest

Field Description
hash
string
PATH to manifests (tar.gz)
path
string
requestTimestamp
Time
hash of manifests, prefixed with type (eg: sha256:xyz)

InstanceStatusManifest v1alpha1

Group Version Kind
wing v1alpha1 InstanceStatusManifest

InstaceSpecManifest defines the state and hash of a run manifest

Field Description
exitCodes
integer array
contains output of the retries
hash
string
lastUpdateTimestamp
Time
hash of manifests, prefixed with type (eg: sha256:xyz)
messages
string array
timestamp when a converge was requested
state
string

InternetGW v1alpha1

Group Version Kind
cluster v1alpha1 InternetGW
Field Description
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/api-conventions.md#resources
identifier
string
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/api-conventions.md#types-kinds
metadata
ObjectMeta

KubernetesAPI v1alpha1

Group Version Kind
cluster v1alpha1 KubernetesAPI
Field Description
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/api-conventions.md#resources
endpoint
string
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/api-conventions.md#types-kinds
metadata
ObjectMeta
port
string

Label v1alpha1

Group Version Kind
cluster v1alpha1 Label

Label structure for instancepool node labels

Field Description
key
string
value
string

LoggingSink v1alpha1

Group Version Kind
cluster v1alpha1 LoggingSink
Field Description
elasticsearch
LoggingSinkElasticsearch
types
string array

LoggingSinkElasticsearch v1alpha1

Group Version Kind
cluster v1alpha1 LoggingSinkElasticsearch
Field Description
amazonESProxy
AmazonESProxy
host
string
https://fluentbit.io/documentation/0.12/output/elasticsearch.html
httpBasicAuth
HTTPBasicAuth
logstashPrefix
string
port
integer
tls
boolean
tlsCA
string
tlsVerify
boolean

Network v1alpha1

Group Version Kind
cluster v1alpha1 Network
Field Description
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/api-conventions.md#resources
cidr
string
identifier
string
internetGW
InternetGW
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/api-conventions.md#types-kinds
metadata
ObjectMeta
type
string

Provider v1alpha1

Group Version Kind
tarmak v1alpha1 Provider
Field Description
amazon
ProviderAmazon
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/api-conventions.md#resources
azure
ProviderAzure
gcp
ProviderGCP
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/api-conventions.md#types-kinds
metadata
ObjectMeta

ProviderAmazon v1alpha1

Group Version Kind
tarmak v1alpha1 ProviderAmazon
Field Description
allowedAccountIDs
string array
bucketPrefix
string
keyName
string
profile
string
publicHostedZoneID
string
publicZone
string
vaultPath
string

ProviderAzure v1alpha1

Group Version Kind
tarmak v1alpha1 ProviderAzure
Field Description
subscriptionID
string

ProviderGCP v1alpha1

Group Version Kind
tarmak v1alpha1 ProviderGCP
Field Description
project
string

SSH v1alpha1

Group Version Kind
cluster v1alpha1 SSH
Field Description
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/api-conventions.md#resources
identifier
string
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/api-conventions.md#types-kinds
metadata
ObjectMeta
privateKeyPath
string
publicKeyData
string
publicKeyFingerprint
string
publicKeyPath
string
user
string

Subnet v1alpha1

Group Version Kind
cluster v1alpha1 Subnet
Field Description
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/api-conventions.md#resources
cidr
string
identifier
string
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/api-conventions.md#types-kinds
location
string
metadata
ObjectMeta
zone
string

Taint v1alpha1

Group Version Kind
cluster v1alpha1 Taint

Taint structure for instancepool node taints

Field Description
effect
string
key
string
value
string

Values v1alpha1

Group Version Kind
cluster v1alpha1 Values
Field Description
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/api-conventions.md#resources
itemMap
object
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/api-conventions.md#types-kinds
metadata
ObjectMeta

Volume v1alpha1

Group Version Kind
cluster v1alpha1 Volume
Field Description
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/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/api-conventions.md#types-kinds
metadata
ObjectMeta
size
Quantity
type
string
Volume Size