kops

---

---

Cluster v1alpha2 kops

apiVersion: kops/v1alpha2
kind: Cluster
metadata:
  creationTimestamp: "2019-12-10T22:42:27Z"
  name: test.example.com
spec:
  api:
    loadBalancer:
      type: Public
      additionalSecurityGroups:
      - sg-exampleid3
      - sg-exampleid4
  authorization:
    rbac: {}
  kubernetesApiAccess:
  - 0.0.0.0/0
  channel: stable
  cloudProvider: aws
  cloudLabels:
    Owner: John Doe
    foo/bar: fib+baz
  configBase: s3://test.example.com/test.example.com
  etcdClusters:
  - etcdMembers:
    - instanceGroup: master-us-test-1a
      name: us-test-1a
    name: main
    version: 3.0.17
  - etcdMembers:
    - instanceGroup: master-us-test-1a
      name: us-test-1a
    name: events
    version: 3.0.17
  kubeAPIServer:
    serviceNodePortRange: 28000-32767
  kubernetesVersion: 1.8.5
  masterInternalName: api.internal.test.example.com
  masterPublicName: api.test.example.com
  networkCIDR: 172.20.0.0/16
  networkID: vpc-12345678
  networking:
    weave: 
      mtu: 8912
  nodePortAccess:
  - 1.2.3.4/32
  - 10.20.30.0/24
  nonMasqueradeCIDR: 100.64.0.0/10
  sshAccess:
  - 0.0.0.0/0
  subnets:
  - cidr: 172.20.32.0/19
    id: subnet-12345678
    name: us-test-1a
    type: Public
    zone: us-test-1a
  - cidr: 172.20.4.0/22
    name: utility-us-test-1a
    type: Utility
    zone: us-test-1a
    id: subnet-12345679
  topology:
    masters: private
    nodes: private

Group	Version	Kind
kops	v1alpha2	Cluster

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
spec ClusterSpec

ClusterSpec v1alpha2 kops

Field	Description
additionalNetworkCIDRs string array	AdditionalNetworkCIDRs is a list of additional CIDR used for the AWS VPC or otherwise allocated to k8s. This is a real CIDR, not the internal k8s network On AWS, it maps to any additional CIDRs added to a VPC.
additionalPolicies object	Additional policies to add for roles
additionalSans string array	AdditionalSANs adds additional Subject Alternate Names to apiserver cert that kops generates
addons AddonSpec array	Additional addons that should be installed on the cluster
api AccessSpec	API field controls how the API is exposed outside the cluster
assets Assets	Alternative locations for files and containers
authentication AuthenticationSpec	Authentication field controls how the cluster is configured for authentication
authorization AuthorizationSpec	Authorization field controls how the cluster is configured for authorization
channel string	The Channel we are following
cloudConfig CloudConfiguration
cloudControllerManager CloudControllerManagerConfig
cloudLabels object	Tags for AWS resources
cloudProvider string	The CloudProvider to use (aws or gce)
clusterDNSDomain string	ClusterDNSDomain is the suffix we use for internal DNS names (normally cluster.local)
configBase string	ConfigBase is the path where we store configuration for the cluster This might be different that the location when the cluster spec itself is stored, both because this must be accessible to the cluster, and because it might be on a different cloud or storage system (etcd vs S3)
configStore string	ConfigStore is the VFS path to where the configuration (Cluster, InstanceGroups etc) is stored
dnsZone string	DNSZone is the DNS zone we should use when configuring DNS This is because some clouds let us define a managed zone foo.bar, and then have kubernetes.dev.foo.bar, without needing to define dev.foo.bar as a hosted zone. DNSZone will probably be a suffix of the MasterPublicName and MasterInternalName Note that DNSZone can either by the host name of the zone (containing dots), or can be an identifier for the zone.
docker DockerConfig	Component configurations
egressProxy EgressProxySpec	HTTPProxy defines connection information to support use of a private cluster behind an forward HTTP Proxy
encryptionConfig boolean	EncryptionConfig holds the encryption config
etcdClusters EtcdClusterSpec array	EtcdClusters stores the configuration for each cluster
externalDns ExternalDNSConfig
fileAssets FileAssetSpec array	A collection of files assets for deployed cluster wide
hooks HookSpec array	Hooks for custom actions e.g. on first installation
iam IAMSpec	IAM field adds control over the IAM security policies applied to resources
isolateMasters boolean	IsolateMasters determines whether we should lock down masters so that they are not on the pod network. true is the kube-up behaviour, but it is very surprising: it means that daemonsets only work on the master if they have hostNetwork=true. false is now the default, and it will: give the master a normal PodCIDR run kube-proxy on the master * enable debugging handlers on the master, so kubectl logs works
keyStore string	KeyStore is the VFS path to where SSL keys and certificates are stored
kubeAPIServer KubeAPIServerConfig
kubeControllerManager KubeControllerManagerConfig
kubeDNS KubeDNSConfig
kubeProxy KubeProxyConfig
kubeScheduler KubeSchedulerConfig
kubelet KubeletConfigSpec
kubernetesApiAccess string array	KubernetesAPIAccess determines the permitted access to the API endpoints (master HTTPS) Currently only a single CIDR is supported (though a richer grammar could be added in future)
kubernetesVersion string	The version of kubernetes to install (optional, and can be a "spec" like stable)
masterInternalName string	MasterInternalName is the internal DNS name for the master nodes
masterKubelet KubeletConfigSpec
masterPublicName string	MasterPublicName is the external DNS name for the master nodes
networkCIDR string	NetworkCIDR is the CIDR used for the AWS VPC / GCE Network, or otherwise allocated to k8s This is a real CIDR, not the internal k8s network On AWS, it maps to the VPC CIDR. It is not required on GCE.
networkID string	NetworkID is an identifier of a network, if we want to reuse/share an existing network (e.g. an AWS VPC)
networking NetworkingSpec	Networking configuration
nodePortAccess string array	NodePortAccess is a list of the CIDRs that can access the node ports range (30000-32767).
nonMasqueradeCIDR string	MasterIPRange string json:",omitempty" NonMasqueradeCIDR is the CIDR for the internal k8s network (on which pods & services live) It cannot overlap ServiceClusterIPRange
project string	Project is the cloud project we should use, required on GCE
secretStore string	SecretStore is the VFS path to where secrets are stored
serviceClusterIPRange string	ServiceClusterIPRange is the CIDR, from the internal network, where we allocate IPs for services
sshAccess string array	SSHAccess determines the permitted access to SSH Currently only a single CIDR is supported (though a richer grammar could be added in future)
sshKeyName string	SSHKeyName specifies a preexisting SSH key to use
subnets ClusterSubnetSpec array	Configuration of subnets we are targeting
target TargetSpec	Target allows for us to nest extra config for targets such as terraform
topology TopologySpec	Topology defines the type of network topology to use on the cluster - default public This is heavily weighted towards AWS for the time being, but should also be agnostic enough to port out to GCE later if needed
updatePolicy string	UpdatePolicy determines the policy for applying upgrades automatically. Valid values: 'external' do not apply updates automatically - they are applied manually or by an external system missing: default policy (currently OS security upgrades that do not require a reboot)

ClusterList v1alpha2 kops

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
items Cluster 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 ListMeta

---

InstanceGroup v1alpha2 kops

apiVersion: kops/v1alpha2
kind: InstanceGroup
metadata:
  creationTimestamp: null
  labels:
    kops.k8s.io/cluster: test.aws.k8spro.com
  name: nodes
spec:
  image: kope.io/k8s-1.8-debian-jessie-amd64-hvm-ebs-2017-12-02
  machineType: t2.medium
  maxSize: 2
  minSize: 2
  minPrice: "0.2"
  cloudLabels:
    team: me
    project: ion
  nodeLabels:
    kops.k8s.io/instancegroup: nodes
  role: Node
  rootVolumeSize: 200
  rootVolumeOptimization: true
  subnets:
  - us-west-2a
  taints:
  - dedicated=gpu:NoSchedule
  - team=search:PreferNoSchedule

Group	Version	Kind
kops	v1alpha2	InstanceGroup

InstanceGroup represents a group of instances (either nodes or masters) with the same configuration

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
spec InstanceGroupSpec

InstanceGroupSpec v1alpha2 kops

Field	Description
additionalSecurityGroups string array	AdditionalSecurityGroups attaches additional security groups (e.g. i-123456)
additionalUserData UserData array	AdditionalUserData is any additional user-data to be passed to the host
associatePublicIp boolean	AssociatePublicIP is true if we want instances to have a public IP
cloudLabels object	CloudLabels indicates the labels for instances in this group, at the AWS level
detailedInstanceMonitoring boolean	DetailedInstanceMonitoring defines if detailed-monitoring is enabled (AWS only)
fileAssets FileAssetSpec array	FileAssets is a collection of file assets for this instance group
hooks HookSpec array	Hooks is a list of hooks for this instanceGroup, note: these can override the cluster wide ones if required
image string	Image is the instance (ami etc) we should use
kubelet KubeletConfigSpec	Kubelet overrides kubelet config from the ClusterSpec
machineType string	MachineType is the instance class
maxPrice string	MaxPrice indicates this is a spot-pricing group, with the specified value as our max-price bid
maxSize integer	MaxSize is the maximum size of the pool
minSize integer	MinSize is the minimum size of the pool
nodeLabels object	NodeLabels indicates the kubernetes labels for nodes in this group
role string	Type determines the role of instances in this group: masters or nodes
rootVolumeIops integer	If volume type is io1, then we need to specify the number of Iops.
rootVolumeOptimization boolean	RootVolumeOptimization enables EBS optimization for an instance
rootVolumeSize integer	RootVolumeSize is the size of the EBS root volume to use, in GB
rootVolumeType string	RootVolumeType is the type of the EBS root volume to use (e.g. gp2)
subnets string array	Subnets is the names of the Subnets (as specified in the Cluster) where machines in this instance group should be placed
suspendProcesses string array	SuspendProcesses disables the listed Scaling Policies
taints string array	Taints indicates the kubernetes taints for nodes in this group
tenancy string	Describes the tenancy of the instance group. Can be either default or dedicated. Currently only applies to AWS.
zones string array	Zones is the names of the Zones where machines in this instance group should be placed This is needed for regional subnets (e.g. GCE), to restrict placement to particular zones

InstanceGroupList v1alpha2 kops

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
items InstanceGroup 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 ListMeta

Definitions

---

APIGroup v1 meta

Group	Version	Kind
meta	v1	APIGroup

APIGroup contains the name, the supported versions, and the preferred version of a group.

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
name string	name is the name of the group.
preferredVersion GroupVersionForDiscovery	preferredVersion is the version preferred by the API server, which probably is the storage version.
serverAddressByClientCIDRs ServerAddressByClientCIDR array	a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
versions GroupVersionForDiscovery array	versions are the versions supported in this group.

APIResource v1 meta

Group	Version	Kind
meta	v1	APIResource

APIResource specifies the name of a resource and whether it is namespaced.

Field	Description
categories string array	categories is a list of the grouped resources this resource belongs to (e.g. 'all')
group string	group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
kind string	kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
name string	name is the plural name of the resource.
namespaced boolean	namespaced indicates if a resource is namespaced or not.
shortNames string array	shortNames is a list of suggested short names of the resource.
singularName string	singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
verbs string array	verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
version string	version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".

AccessSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	AccessSpec

AccessSpec provides configuration details related to kubeapi dns and ELB access

Field	Description
dns DNSAccessSpec	DNS will be used to provide config on kube-apiserver ELB DNS
loadBalancer LoadBalancerAccessSpec	LoadBalancer is the configuration for the kube-apiserver ELB

AddonSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	AddonSpec

AddonSpec defines an addon that we want to install in the cluster

Field	Description
manifest string	Manifest is a path to the manifest that defines the addon

AlwaysAllowAuthorizationSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	AlwaysAllowAuthorizationSpec

Field	Description

AmazonVPCNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	AmazonVPCNetworkingSpec

AmazonVPCNetworkingSpec declares that we want Amazon VPC CNI networking

Field	Description

Assets v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	Assets

Assets defined the privately hosted assets

Field	Description
containerRegistry string	ContainerRegistry is a url for to a docker registry
fileRepository string	FileRepository is the url for a private file serving repository

AuthenticationSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	AuthenticationSpec

Field	Description
kopeio KopeioAuthenticationSpec

AuthorizationSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	AuthorizationSpec

Field	Description
alwaysAllow AlwaysAllowAuthorizationSpec
rbac RBACAuthorizationSpec

BastionSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	BastionSpec

Field	Description
bastionPublicName string
idleTimeoutSeconds integer	IdleTimeoutSeconds is the bastion's Loadbalancer idle timeout

CNINetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	CNINetworkingSpec

CNINetworkingSpec is the specification for networking that is implemented by a Daemonset Networking is not managed by kops - we can create options here that directly configure e.g. weave but this is useful for arbitrary network modes or for modes that don't need additional configuration.

Field	Description

CalicoNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	CalicoNetworkingSpec

CalicoNetworkingSpec declares that we want Calico networking

Field	Description
crossSubnet boolean
logSeverityScreen string	LogSeverityScreen lets us set the desired log level. (Default: info)
prometheusGoMetricsEnabled boolean	PrometheusGoMetricsEnabled enables Prometheus Go runtime metrics collection
prometheusMetricsEnabled boolean	PrometheusMetricsEnabled can be set to enable the experimental Prometheus metrics server (default: false)
prometheusMetricsPort integer	PrometheusMetricsPort is the TCP port that the experimental Prometheus metrics server should bind to (default: 9091)
prometheusProcessMetricsEnabled boolean	PrometheusProcessMetricsEnabled enables Prometheus process metrics collection

CanalNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	CanalNetworkingSpec

CanalNetworkingSpec declares that we want Canal networking

Field	Description
chainInsertMode string	ChainInsertMode controls whether Felix inserts rules to the top of iptables chains, or appends to the bottom. Leaving the default option is safest to prevent accidentally breaking connectivity. Default: 'insert' (other options: 'append')
defaultEndpointToHostAction string	DefaultEndpointToHostAction allows users to configure the default behaviour for traffic between pod to host after calico rules have been processed. Default: ACCEPT (other options: DROP, RETURN)
prometheusGoMetricsEnabled boolean	PrometheusGoMetricsEnabled enables Prometheus Go runtime metrics collection
prometheusMetricsEnabled boolean	PrometheusMetricsEnabled can be set to enable the experimental Prometheus metrics server (default: false)
prometheusMetricsPort integer	PrometheusMetricsPort is the TCP port that the experimental Prometheus metrics server should bind to (default: 9091)
prometheusProcessMetricsEnabled boolean	PrometheusProcessMetricsEnabled enables Prometheus process metrics collection

CiliumNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	CiliumNetworkingSpec

CiliumNetworkingSpec declares that we want Cilium networking

Field	Description
debug boolean
tunnel string

ClassicNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	ClassicNetworkingSpec

ClassicNetworkingSpec is the specification of classic networking mode, integrated into kubernetes

Field	Description

CloudConfiguration v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	CloudConfiguration

CloudConfiguration defines the cloud provider configuration

Field	Description
disableSecurityGroupIngress boolean	AWS cloud-config options
elbSecurityGroup string
multizone boolean	GCE cloud-config options
nodeInstancePrefix string
nodeTags string
vSphereCoreDNSServer string
vSphereDatacenter string
vSphereDatastore string
vSpherePassword string
vSphereResourcePool string
vSphereServer string
vSphereUsername string	vSphere cloud-config specs

CloudControllerManagerConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	CloudControllerManagerConfig

Field	Description
allocateNodeCIDRs boolean	AllocateNodeCIDRs enables CIDRs for Pods to be allocated and, if ConfigureCloudRoutes is true, to be set on the cloud provider.
cidrAllocatorType string	CIDRAllocatorType specifies the type of CIDR allocator to use.
cloudProvider string	CloudProvider is the provider for cloud services.
clusterCIDR string	ClusterCIDR is CIDR Range for Pods in cluster.
clusterName string	ClusterName is the instance prefix for the cluster.
configureCloudRoutes boolean	ConfigureCloudRoutes enables CIDRs allocated with to be configured on the cloud provider.
image string	Image is the OCI image of the cloud controller manager.
leaderElection LeaderElectionConfiguration	LeaderElection defines the configuration of leader election client.
logLevel integer	LogLevel is the verbosity of the logs.
master string	Master is the url for the kube api master.
useServiceAccountCredentials boolean	UseServiceAccountCredentials controls whether we use individual service account credentials for each controller.

ClusterSubnetSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	ClusterSubnetSpec

Field	Description
cidr string
egress string	Egress defines the method of traffic egress for this subnet
id string	ProviderID is the cloud provider id for the objects associated with the zone (the subnet on AWS)
name string
publicIP string	PublicIP to attach to NatGateway
region string	Region is the region the subnet is in, set for subnets that are regionally scoped
type string
zone string	Zone is the zone the subnet is in, set for subnets that are zonally scoped

DNSAccessSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	DNSAccessSpec

Field	Description

DNSSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	DNSSpec

Field	Description
type string

DeleteOptions v1 meta

Group	Version	Kind
meta	v1	DeleteOptions

DeleteOptions may be provided when deleting an API object.

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
gracePeriodSeconds integer	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
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
orphanDependents boolean	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
preconditions Preconditions	Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
propagationPolicy string	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

DockerConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	DockerConfig

DockerConfig is the configuration for docker

Field	Description
authorizationPlugins string array	AuthorizationPlugins is a list of authorization plugins
bridge string	Bridge is the network interface containers should bind onto
bridgeIP string	BridgeIP is a specific IP address and netmask for the docker0 bridge, using standard CIDR notation
defaultUlimit string array	DefaultUlimit is the ulimits for containers
hosts string array	Hosts enables you to configure the endpoints the docker daemon listens on i.e. tcp://0.0.0.0.2375 or unix:///var/run/docker.sock etc
insecureRegistry string	InsecureRegistry enable insecure registry communication @question according to dockers this a list??
ipMasq boolean	IPMasq enables ip masquerading for containers
ipTables boolean	IPtables enables addition of iptables rules
liveRestore boolean	LiveRestore enables live restore of docker when containers are still running
logDriver string	LogDriver is the default driver for container logs (default "json-file")
logLevel string	LogLevel is the logging level ("debug", "info", "warn", "error", "fatal") (default "info")
logOpt string array	Logopt is a series of options given to the log driver options for containers
mtu integer	MTU is the containers network MTU
registryMirrors string array	RegistryMirrors is a referred list of docker registry mirror
storage string	Storage is the docker storage driver to use
storageOpts string array	StorageOpts is a series of options passed to the storage driver
version string	Version is consumed by the nodeup and used to pick the docker version

Duration v1 meta

Group	Version	Kind
meta	v1	Duration

Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.

Field	Description
Duration integer

EgressProxySpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	EgressProxySpec

Field	Description
excludes string
httpProxy HTTPProxy

EtcdBackupSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	EtcdBackupSpec

EtcdBackupSpec describes how we want to do backups of etcd

Field	Description
backupStore string	BackupStore is the VFS path where we will read/write backup data
image string	Image is the etcd backup manager image to use. Setting this will create a sidecar container in the etcd pod with the specified image.

EtcdClusterSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	EtcdClusterSpec

EtcdClusterSpec is the etcd cluster specification

Field	Description
backups EtcdBackupSpec	Backups describes how we do backups of etcd
enableEtcdTLS boolean	EnableEtcdTLS indicates the etcd service should use TLS between peers and clients
enableTLSAuth boolean	EnableTLSAuth indicates client and peer TLS auth should be enforced
etcdMembers EtcdMemberSpec array	Members stores the configurations for each member of the cluster (including the data volume)
heartbeatInterval Duration	HeartbeatInterval is the time (in milliseconds) for an etcd heartbeat interval
image string	Image is the etcd docker image to use. Setting this will ignore the Version specified.
leaderElectionTimeout Duration	LeaderElectionTimeout is the time (in milliseconds) for an etcd leader election timeout
name string	Name is the name of the etcd cluster (main, events etc)
version string	Version is the version of etcd to run i.e. 2.1.2, 3.0.17 etcd

EtcdMemberSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	EtcdMemberSpec

EtcdMemberSpec is a specification for a etcd member

Field	Description
encryptedVolume boolean	EncryptedVolume indicates you want to encrypt the volume
instanceGroup string	InstanceGroup is the instanceGroup this volume is associated
kmsKeyId string	KmsKeyId is a AWS KMS ID used to encrypt the volume
name string	Name is the name of the member within the etcd cluster
volumeIops integer	If volume type is io1, then we need to specify the number of Iops.
volumeSize integer	VolumeSize is the underlying cloud volume size
volumeType string	VolumeType is the underlying cloud storage class

ExecContainerAction v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	ExecContainerAction

ExecContainerAction defines an hood action

Field	Description
command string array	Command is the command supplied to the above image
environment object	Environment is a map of environment variables added to the hook
image string	Image is the docker image

ExternalDNSConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	ExternalDNSConfig

ExternalDNSConfig are options of the dns-controller

Field	Description
disable boolean	Disable indicates we do not wish to run the dns-controller addon
watchIngress boolean	WatchIngress indicates you want the dns-controller to watch and create dns entries for ingress resources
watchNamespace string	WatchNamespace is namespace to watch, defaults to all (use to control whom can creates dns entries)

ExternalNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	ExternalNetworkingSpec

ExternalNetworkingSpec is the specification for networking that is implemented by a Daemonset It also uses kubenet

Field	Description

FileAssetSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	FileAssetSpec

FileAssetSpec defines the structure for a file asset

Field	Description
content string	Content is the contents of the file
isBase64 boolean	IsBase64 indicates the contents is base64 encoded
name string	Name is a shortened reference to the asset
path string	Path is the location this file should reside
roles string array	Roles is a list of roles the file asset should be applied, defaults to all

FlannelNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	FlannelNetworkingSpec

FlannelNetworkingSpec declares that we want Flannel networking

Field	Description
backend string	Backend is the backend overlay type we want to use (vxlan or udp)

GroupVersionForDiscovery v1 meta

Group	Version	Kind
meta	v1	GroupVersionForDiscovery

GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.

Field	Description
groupVersion string	groupVersion specifies the API group and version in the form "group/version"
version string	version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.

HTTPProxy v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	HTTPProxy

Field	Description
host string
port integer

HookSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	HookSpec

HookSpec is a definition hook

Field	Description
before string array	Before is a series of systemd units which this hook must run before
disabled boolean	Disabled indicates if you want the unit switched off
execContainer ExecContainerAction	ExecContainer is the image itself
manifest string	Manifest is a raw systemd unit file
name string	Name is an optional name for the hook, otherwise the name is kops-hook-
requires string array	Requires is a series of systemd units the action requires
roles string array	Roles is an optional list of roles the hook should be rolled out to, defaults to all

IAMSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	IAMSpec

IAMSpec adds control over the IAM security policies applied to resources

Field	Description
allowContainerRegistry boolean
legacy boolean

Initializer v1 meta

Group	Version	Kind
meta	v1	Initializer

Initializer is information about an initializer that has not yet completed.

Field	Description
name string	name of the process that is responsible for initializing this object.

Initializers v1 meta

Group	Version	Kind
meta	v1	Initializers

Initializers tracks the progress of initialization.

Field	Description
pending Initializer array patch type: merge patch merge key: name	Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
result Status	If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.

KopeioAuthenticationSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KopeioAuthenticationSpec

Field	Description

KopeioNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KopeioNetworkingSpec

KopeioNetworkingSpec declares that we want Kopeio networking

Field	Description

KubeAPIServerConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KubeAPIServerConfig

KubeAPIServerConfig defines the configuration for the kube api

Field	Description
address string	Address is the binding address for the kube api
admissionControl string array	AdmissionControl is a list of admission controllers to user
allowPrivileged boolean	AllowPrivileged indicates if we can run privileged containers
anonymousAuth boolean	AnonymousAuth indicates if anonymous authentication is permitted
apiServerCount integer	APIServerCount is the number of api servers
auditLogFormat string	AuditLogFormat flag specifies the format type for audit log files.
auditLogMaxAge integer	The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
auditLogMaxBackups integer	The maximum number of old audit log files to retain.
auditLogMaxSize integer	The maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB.
auditLogPath string	If set, all requests coming to the apiserver will be logged to this file.
auditPolicyFile string	AuditPolicyFile is the full path to a advanced audit configuration file e.g. /srv/kubernetes/audit.conf
authenticationTokenWebhookCacheTtl Duration	The duration to cache responses from the webhook token authenticator. Default is 2m. (default 2m0s)
authenticationTokenWebhookConfigFile string	File with webhook configuration for token authentication in kubeconfig format. The API server will query the remote service to determine authentication for bearer tokens.
authorizationMode string	AuthorizationMode is the authorization mode the kubeapi is running in
authorizationRbacSuperUser string	AuthorizationRBACSuperUser is the name of the superuser for default rbac
basicAuthFile string
clientCAFile string
cloudProvider string	CloudProvider is the name of the cloudProvider we are using, aws, gce etcd
etcdCaFile string	EtcdCAFile is the path to a ca certificate
etcdCertFile string	EtcdCertFile is the path to a certificate
etcdKeyFile string	EtcdKeyFile is the path to a private key
etcdQuorumRead boolean	EtcdQuorumRead configures the etcd-quorum-read flag, which forces consistent reads from etcd
etcdServers string array	EtcdServers is a list of the etcd service to connect
etcdServersOverrides string array	EtcdServersOverrides is per-resource etcd servers overrides, comma separated. The individual override format: group/resource#servers, where servers are http://ip:port, semicolon separated
experimentalEncryptionProviderConfig string	ExperimentalEncryptionProviderConfig enables encryption at rest for secrets.
featureGates object	FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
image string	Image is the docker container used
insecurePort integer	InsecurePort is the port the insecure api runs
kubeletClientCertificate string	KubeletClientCertificate is the path of a certificate for secure communication between api and kubelet
kubeletClientKey string	KubeletClientKey is the path of a private to secure communication between api and kubelet
kubeletPreferredAddressTypes string array	KubeletPreferredAddressTypes is a list of the preferred NodeAddressTypes to use for kubelet connections
logLevel integer	LogLevel is the logging level of the api
maxRequestsInflight integer	MaxRequestsInflight The maximum number of non-mutating requests in flight at a given time.
oidcCAFile string	OIDCCAFile if set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file
oidcClientID string	OIDCClientID is the client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
oidcGroupsClaim string	OIDCGroupsClaim 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.
oidcGroupsPrefix string	OIDCGroupsPrefix is the prefix prepended to group claims to prevent clashes with existing names (such as 'system:' groups)
oidcIssuerURL string	OIDCIssuerURL is 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).
oidcUsernameClaim string	OIDCUsernameClaim is 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.
oidcUsernamePrefix string	OIDCUsernamePrefix is the prefix prepended to username claims to prevent clashes with existing names (such as 'system:' users).
proxyClientCertFile string	The apiserver's client certificate used for outbound requests.
proxyClientKeyFile string	The apiserver's client key used for outbound requests.
requestheaderAllowedNames string array	List of client certificate common names to allow to provide usernames in headers specified by --requestheader-username-headers. If empty, any client certificate validated by the authorities in --requestheader-client-ca-file is allowed.
requestheaderClientCAFile string	Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers
requestheaderExtraHeaderPrefixes string array	List of request header prefixes to inspect. X-Remote-Extra- is suggested.
requestheaderGroupHeaders string array	List of request headers to inspect for groups. X-Remote-Group is suggested.
requestheaderUsernameHeaders string array	List of request headers to inspect for usernames. X-Remote-User is common.
runtimeConfig object	RuntimeConfig is a series of keys/values are parsed into the --runtime-config parameters
securePort integer	SecurePort is the port the kube runs on
serviceClusterIPRange string	ServiceClusterIPRange is the service address range
serviceNodePortRange string	Passed as --service-node-port-range to kube-apiserver. Expects 'startPort-endPort' format. Eg. 30000-33000
storageBackend string	StorageBackend is the backend storage
tlsCertFile string
tlsPrivateKeyFile string
tokenAuthFile string

KubeControllerManagerConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KubeControllerManagerConfig

KubeControllerManagerConfig is the configuration for the controller

Field	Description
allocateNodeCIDRs boolean	AllocateNodeCIDRs enables CIDRs for Pods to be allocated and, if ConfigureCloudRoutes is true, to be set on the cloud provider.
attachDetachReconcileSyncPeriod Duration	ReconcilerSyncLoopPeriod is the amount of time the reconciler sync states loop wait between successive executions. Is set to 1 min by kops by default
cidrAllocatorType string	CIDRAllocatorType specifies the type of CIDR allocator to use.
cloudProvider string	CloudProvider is the provider for cloud services.
clusterCIDR string	ClusterCIDR is CIDR Range for Pods in cluster.
clusterName string	ClusterName is the instance prefix for the cluster.
configureCloudRoutes boolean	ConfigureCloudRoutes enables CIDRs allocated with to be configured on the cloud provider.
featureGates object	FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
horizontalPodAutoscalerDownscaleDelay Duration	HorizontalPodAutoscalerDownscaleDelay is a duration that specifies how long the autoscaler has to wait before another downscale operation can be performed after the current one has completed.
horizontalPodAutoscalerSyncPeriod Duration	HorizontalPodAutoscalerSyncPeriod is the amount of time between syncs During each period, the controller manager queries the resource utilization against the metrics specified in each HorizontalPodAutoscaler definition.
horizontalPodAutoscalerUpscaleDelay Duration	HorizontalPodAutoscalerUpscaleDelay is a duration that specifies how long the autoscaler has to wait before another upscale operation can be performed after the current one has completed.
horizontalPodAutoscalerUseRestClients boolean	HorizontalPodAutoscalerUseRestClients determines if the new-style clients should be used if support for custom metrics is enabled.
image string	Image is the docker image to use
leaderElection LeaderElectionConfiguration	LeaderElection defines the configuration of leader election client.
logLevel integer	LogLevel is the defined logLevel
master string	Master is the url for the kube api master
nodeMonitorGracePeriod Duration	NodeMonitorGracePeriod is the amount of time which we allow running Node to be unresponsive before marking it unhealthy. (default 40s) Must be N-1 times more than kubelet's nodeStatusUpdateFrequency, where N means number of retries allowed for kubelet to post node status.
nodeMonitorPeriod Duration	NodeMonitorPeriod is the period for syncing NodeStatus in NodeController. (default 5s)
podEvictionTimeout Duration	PodEvictionTimeout is the grace period for deleting pods on failed nodes. (default 5m0s)
rootCAFile string	rootCAFile is the root certificate authority will be included in service account's token secret. This must be a valid PEM-encoded CA bundle.
serviceAccountPrivateKeyFile string	ServiceAccountPrivateKeyFile the location for a certificate for service account signing
terminatedPodGCThreshold integer	TerminatedPodGCThreshold is the number of terminated pods that can exist before the terminated pod garbage collector starts deleting terminated pods. If <= 0, the terminated pod garbage collector is disabled.
useServiceAccountCredentials boolean	UseServiceAccountCredentials controls whether we use individual service account credentials for each controller.

KubeDNSConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KubeDNSConfig

Field	Description
cacheMaxConcurrent integer	CacheMaxConcurrent is the maximum number of concurrent queries for dnsmasq
cacheMaxSize integer	CacheMaxSize is the maximum entries to keep in dnsmaq
domain string
image string	Image is the name of the docker image to run Deprecated as this is now in the addon
replicas integer	Deprecated as this is now in the addon, and controlled by autoscaler
serverIP string

KubeProxyConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KubeProxyConfig

KubeProxyConfig defines the configuration for a proxy

Field	Description
clusterCIDR string	ClusterCIDR is the CIDR range of the pods in the cluster
cpuLimit string	CPULimit, cpu limit compute resource for kube proxy e.g. "30m"
cpuRequest string	CPURequest, cpu request compute resource for kube proxy e.g. "20m"
enabled boolean	Enabled allows enabling or disabling kube-proxy
featureGates object	FeatureGates is a series of key pairs used to switch on features for the proxy
hostnameOverride string	HostnameOverride, if non-empty, will be used as the identity instead of the actual hostname.
image string
logLevel integer	LogLevel is the logging level of the proxy
master string	Master is the address of the Kubernetes API server (overrides any value in kubeconfig)
memoryLimit string	MemoryLimit, memory limit compute resource for kube proxy e.g. "30Mi"
memoryRequest string	MemoryRequest, memory request compute resource for kube proxy e.g. "30Mi"
proxyMode string	Which proxy mode to use: (userspace, iptables, ipvs)

KubeSchedulerConfig v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KubeSchedulerConfig

KubeSchedulerConfig is the configuration for the kube-scheduler

Field	Description
featureGates object	FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
image string	Image is the docker image to use
leaderElection LeaderElectionConfiguration	LeaderElection defines the configuration of leader election client.
logLevel integer	LogLevel is the logging level
master string	Master is a url to the kube master
usePolicyConfigMap boolean	UsePolicyConfigMap enable setting the scheduler policy from a configmap

KubeletConfigSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KubeletConfigSpec

KubeletConfigSpec defines the kubelet configuration

Field	Description
allowPrivileged boolean	AllowPrivileged enables containers to request privileged mode (defaults to false)
anonymousAuth boolean	AnonymousAuth permits you to control auth to the kubelet api
apiServers string	APIServers is not used for clusters version 1.6 and later - flag removed
authorizationMode string	AuthorizationMode is the authorization mode the kubelet is running in
babysitDaemons boolean	The node has babysitter process monitoring docker and kubelet. Removed as of 1.7
cgroupRoot string	cgroupRoot is the root cgroup to use for pods. This is handled by the container runtime on a best effort basis.
clientCaFile string	ClientCAFile is the path to a CA certificate
cloudProvider string	CloudProvider is the provider for cloud services.
clusterDNS string	ClusterDNS is the IP address for a cluster DNS server
clusterDomain string	ClusterDomain is the DNS domain for this cluster
configureCbr0 boolean	configureCBR0 enables the kubelet to configure cbr0 based on Node.Spec.PodCIDR.
enableCustomMetrics boolean	Enable gathering custom metrics.
enableDebuggingHandlers boolean	EnableDebuggingHandlers enables server endpoints for log collection and local running of containers and commands
enforceNodeAllocatable string	Enforce Allocatable across pods whenever the overall usage across all pods exceeds Allocatable.
evictionHard string	Comma-delimited list of hard eviction expressions. For example, 'memory.available<300Mi'.
evictionMaxPodGracePeriod integer	Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met.
evictionMinimumReclaim string	Comma-delimited list of minimum reclaims (e.g. imagefs.available=2Gi) that describes the minimum amount of resource the kubelet will reclaim when performing a pod eviction if that resource is under pressure.
evictionPressureTransitionPeriod Duration	Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition.
evictionSoft string	Comma-delimited list of soft eviction expressions. For example, 'memory.available<300Mi'.
evictionSoftGracePeriod string	Comma-delimited list of grace periods for each soft eviction signal. For example, 'memory.available=30s'.
failSwapOn boolean	Tells the Kubelet to fail to start if swap is enabled on the node.
featureGates object	FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
hairpinMode string	How should the kubelet configure the container bridge for hairpin packets. Setting this flag allows endpoints in a Service to loadbalance back to themselves if they should try to access their own Service. Values: "promiscuous-bridge": make the container bridge promiscuous. "hairpin-veth": set the hairpin flag on container veth interfaces. "none": do nothing. Setting --configure-cbr0 to false implies that to achieve hairpin NAT one must set --hairpin-mode=veth-flag, because bridge assumes the existence of a container bridge named cbr0.
hostnameOverride string	HostnameOverride is the hostname used to identify the kubelet instead of the actual hostname.
imageGCHighThresholdPercent integer	ImageGCHighThresholdPercent is the percent of disk usage after which image garbage collection is always run.
imageGCLowThresholdPercent integer	ImageGCLowThresholdPercent is the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to.
imagePullProgressDeadline Duration	ImagePullProgressDeadline is the timeout for image pulls If no pulling progress is made before this deadline, the image pulling will be cancelled. (default 1m0s)
kubeReserved object	Resource reservation for kubernetes system daemons like the kubelet, container runtime, node problem detector, etc.
kubeReservedCgroup string	Control group for kube daemons.
kubeconfigPath string	KubeconfigPath is the path of kubeconfig for the kubelet
kubeletCgroups string	KubeletCgroups is the absolute name of cgroups to isolate the kubelet in.
logLevel integer	LogLevel is the logging level of the kubelet
maxPods integer	MaxPods is the number of pods that can run on this Kubelet.
networkPluginMTU integer	NetworkPluginMTU is the MTU to be passed to the network plugin, and overrides the default MTU for cases where it cannot be automatically computed (such as IPSEC).
networkPluginName string	NetworkPluginName is the name of the network plugin to be invoked for various events in kubelet/pod lifecycle
nodeLabels object	NodeLabels to add when registering the node in the cluster.
nodeStatusUpdateFrequency Duration	NodeStatusUpdateFrequency Specifies how often kubelet posts node status to master (default 10s) must work with nodeMonitorGracePeriod in KubeControllerManagerConfig.
nonMasqueradeCIDR string	NonMasqueradeCIDR configures masquerading: traffic to IPs outside this range will use IP masquerade.
nvidiaGPUs integer	NvidiaGPUs is the number of NVIDIA GPU devices on this node.
podCIDR string	PodCIDR is the CIDR to use for pod IP addresses, only used in standalone mode. In cluster mode, this is obtained from the master.
podInfraContainerImage string	PodInfraContainerImage is the image whose network/ipc containers in each pod will use.
podManifestPath string	config is the path to the config file or directory of files
readOnlyPort integer	ReadOnlyPort is the port used by the kubelet api for read-only access (default 10255)
reconcileCIDR boolean	ReconcileCIDR is Reconcile node CIDR with the CIDR specified by the API server. No-op if register-node or configure-cbr0 is false.
registerNode boolean	RegisterNode enables automatic registration with the apiserver.
registerSchedulable boolean	registerSchedulable tells the kubelet to register the node as schedulable. No-op if register-node is false.
requireKubeconfig boolean	RequireKubeconfig indicates a kubeconfig is required
resolvConf string	ResolverConfig is the resolver configuration file used as the basis for the container DNS resolution configuration."), []
runtimeCgroups string	Cgroups that container runtime is expected to be isolated in.
runtimeRequestTimeout Duration	RuntimeRequestTimeout is timeout for runtime requests on - pull, logs, exec and attach
seccompProfileRoot string	SeccompProfileRoot is the directory path for seccomp profiles.
serializeImagePulls boolean	// SerializeImagePulls when enabled, tells the Kubelet to pull images one // at a time. We recommend not changing the default value on nodes that // run docker daemon with version < 1.9 or an Aufs storage backend. // Issue #10959 has more details.
systemCgroups string	SystemCgroups is absolute name of cgroups in which to place all non-kernel processes that are not already in a container. Empty for no container. Rolling back the flag requires a reboot.
systemReserved object	Capture resource reservation for OS system daemons like sshd, udev, etc.
systemReservedCgroup string	Parent control group for OS system daemons.
taints string array	Taints to add when registering a node in the cluster
volumePluginDirectory string	The full path of the directory in which to search for additional third party volume plugins
volumeStatsAggPeriod Duration	VolumeStatsAggPeriod is the interval for kubelet to calculate and cache the volume disk usage for all pods and volumes

KubenetNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KubenetNetworkingSpec

KubenetNetworkingSpec is the specification for kubenet networking, largely integrated but intended to replace classic

Field	Description

KuberouterNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	KuberouterNetworkingSpec

KuberouterNetworkingSpec declares that we want Kube-router networking

Field	Description

LeaderElectionConfiguration v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	LeaderElectionConfiguration

LeaderElectionConfiguration defines the configuration of leader election clients for components that can run with leader election enabled.

Field	Description
leaderElect boolean	leaderElect enables a leader election client to gain leadership before executing the main loop. Enable this when running replicated components for high availability.

ListMeta v1 meta

Group	Version	Kind
meta	v1	ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Field	Description
continue string	continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
resourceVersion string	String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
selfLink string	selfLink is a URL representing this object. Populated by the system. Read-only.

LoadBalancerAccessSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	LoadBalancerAccessSpec

LoadBalancerAccessSpec provides configuration details related to API LoadBalancer and its access

Field	Description
additionalSecurityGroups string array
idleTimeoutSeconds integer
type string

NetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	NetworkingSpec

NetworkingSpec allows selection and configuration of a networking plugin

Field	Description
amazonvpc AmazonVPCNetworkingSpec
calico CalicoNetworkingSpec
canal CanalNetworkingSpec
cilium CiliumNetworkingSpec
classic ClassicNetworkingSpec
cni CNINetworkingSpec
external ExternalNetworkingSpec
flannel FlannelNetworkingSpec
kopeio KopeioNetworkingSpec
kubenet KubenetNetworkingSpec
kuberouter KuberouterNetworkingSpec
romana RomanaNetworkingSpec
weave WeaveNetworkingSpec

ObjectMeta v1 meta

Group	Version	Kind
meta	v1	ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Field	Description
annotations object	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
clusterName string	The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
creationTimestamp Time	CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
deletionGracePeriodSeconds integer	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
deletionTimestamp Time	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
finalizers string array patch type: merge	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
generateName string	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
generation integer	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
initializers Initializers	An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
labels object	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
name string	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
namespace string	Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
ownerReferences OwnerReference array patch type: merge patch merge key: uid	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
resourceVersion string	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
selfLink string	SelfLink is a URL representing this object. Populated by the system. Read-only.
uid string	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

OwnerReference v1 meta

Group	Version	Kind
meta	v1	OwnerReference

OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.

Field	Description
apiVersion string	API version of the referent.
blockOwnerDeletion boolean	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
controller boolean	If true, this reference points to the managing controller.
kind string	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name string	Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
uid string	UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

Patch v1 meta

Group	Version	Kind
meta	v1	Patch

Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.

Field	Description

Preconditions v1 meta

Group	Version	Kind
meta	v1	Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Field	Description
uid string	Specifies the target UID.

RBACAuthorizationSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	RBACAuthorizationSpec

Field	Description

RomanaNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	RomanaNetworkingSpec

RomanaNetworkingSpec declares that we want Romana networking

Field	Description
daemonServiceIP string	DaemonServiceIP is the Kubernetes Service IP for the romana-daemon pod
etcdServiceIP string	EtcdServiceIP is the Kubernetes Service IP for the etcd backend used by Romana

ServerAddressByClientCIDR v1 meta

Group	Version	Kind
meta	v1	ServerAddressByClientCIDR

ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.

Field	Description
clientCIDR string	The CIDR with which clients can match their IP to figure out the server address that they should use.
serverAddress string	Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.

Status v1 meta

Group	Version	Kind
meta	v1	Status

Status is a return value for calls that don't return other objects.

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
code integer	Suggested HTTP return code for this status, 0 if not set.
details StatusDetails	Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
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
message string	A human-readable description of the status of this operation.
metadata ListMeta	Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
reason string	A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
status string	Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

StatusCause v1 meta

Group	Version	Kind
meta	v1	StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Field	Description
field string	The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items[0].name" - the field "name" on the first array entry in "items"
message string	A human-readable description of the cause of the error. This field may be presented as-is to a reader.
reason string	A machine-readable description of the cause of the error. If this value is empty there is no information available.

StatusDetails v1 meta

Group	Version	Kind
meta	v1	StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Field	Description
causes StatusCause array	The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
group string	The group attribute of the resource associated with the status StatusReason.
kind string	The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
name string	The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
retryAfterSeconds integer	If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
uid string	UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids

TargetSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	TargetSpec

TargetSpec allows for specifying target config in an extensible way

Field	Description
terraform TerraformSpec

TerraformSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	TerraformSpec

TerraformSpec allows us to specify terraform config in an extensible way

Field	Description
providerExtraConfig object	ProviderExtraConfig contains key/value pairs to add to the rendered terraform "provider" block

Time v1 meta

Group	Version	Kind
meta	v1	Time

Field	Description

TopologySpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	TopologySpec

Field	Description
bastion BastionSpec	Bastion provide an external facing point of entry into a network containing private network instances. This host can provide a single point of fortification or audit and can be started and stopped to enable or disable inbound SSH communication from the Internet, some call bastion as the "jump server".
dns DNSSpec	DNS configures options relating to DNS, in particular whether we use a public or a private hosted zone
masters string	The environment to launch the Kubernetes masters in public	private
nodes string	The environment to launch the Kubernetes nodes in public	private

UserData v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	UserData

UserData defines a user-data section

Field	Description
content string	Content is the user-data content
name string	Name is the name of the user-data
type string	Type is the type of user-data

WatchEvent v1 meta

Group	Version	Kind
meta	v1	WatchEvent

Event represents a single event to a watched resource.

Field	Description
object	Object is: If Type is Added or Modified: the new state of the object. If Type is Deleted: the state of the object immediately before deletion. If Type is Error: Status is recommended; other types may make sense depending on context.
type string

WeaveNetworkingSpec v1alpha2 kops

Group	Version	Kind
kops	v1alpha2	WeaveNetworkingSpec

WeaveNetworkingSpec declares that we want Weave networking

Field	Description
connLimit integer
mtu integer

Old Versions

---