mirror of https://github.com/kubernetes/kops.git
Update generated docs
This commit is contained in:
Justin Santa Barbara
parent
b6789822f1
commit
738cadb45a
|
|
@ -42,7 +42,7 @@ As a NodeJS program, a valid installation of node is required. Once node is inst
|
|||
```
|
||||
node --version
|
||||
```
|
||||
Next, dependencies need to be installed via npm from the root of the project directory.
|
||||
Next, depedencies need to be installed via npm from the root of the project directory.
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
|
||||
# <strong>Definitions</strong>
|
||||
|
||||
------------
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## AccessSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | AccessSpec
|
||||
|
||||
|
||||
|
||||
AccessSpec provides configuration details related to kubeapi dns and ELB access
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
dns <br /> *[DNSAccessSpec](#dnsaccessspec-v1alpha2-kops)* | DNS wil be used to provide config on kube-apiserver elb dns
|
||||
loadBalancer <br /> *[LoadBalancerAccessSpec](#loadbalanceraccessspec-v1alpha2-kops)* | LoadBalancer is the configuration for the kube-apiserver ELB
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## AddonSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | AddonSpec
|
||||
|
||||
|
||||
|
||||
AddonSpec defines an addon that we want to install in the cluster
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
manifest <br /> *string* | Manifest is a path to the manifest that defines the addon
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## AlwaysAllowAuthorizationSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | AlwaysAllowAuthorizationSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#authorizationspec-v1alpha2-kops">AuthorizationSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## AmazonVPCNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | AmazonVPCNetworkingSpec
|
||||
|
||||
|
||||
|
||||
AmazonVPCNetworkingSpec declares that we want Amazon VPC CNI networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## APIGroup v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | APIGroup
|
||||
|
||||
|
||||
|
||||
APIGroup contains the name, the supported versions, and the preferred version of a group.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#apigrouplist-v1-meta">APIGroupList meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *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 <br /> *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 <br /> *string* | name is the name of the group.
|
||||
preferredVersion <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-v1-meta)* | preferredVersion is the version preferred by the API server, which probably is the storage version.
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-v1-meta) 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 <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-v1-meta) array* | versions are the versions supported in this group.
|
||||
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
## APIResource v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | APIResource
|
||||
|
||||
|
||||
|
||||
APIResource specifies the name of a resource and whether it is namespaced.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#apiresourcelist-v1-meta">APIResourceList meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
categories <br /> *string array* | categories is a list of the grouped resources this resource belongs to (e.g. 'all')
|
||||
group <br /> *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 <br /> *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
|
||||
name <br /> *string* | name is the plural name of the resource.
|
||||
namespaced <br /> *boolean* | namespaced indicates if a resource is namespaced or not.
|
||||
shortNames <br /> *string array* | shortNames is a list of suggested short names of the resource.
|
||||
singularName <br /> *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 <br /> *string array* | verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
|
||||
version <br /> *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)".
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## Assets v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | Assets
|
||||
|
||||
|
||||
|
||||
Assets defined the privately hosted assets
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerRegistry <br /> *string* | ContainerRegistry is a url for to a docker registry
|
||||
fileRepository <br /> *string* | FileRepository is the url for a private file serving repository
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## AuthenticationSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | AuthenticationSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
kopeio <br /> *[KopeioAuthenticationSpec](#kopeioauthenticationspec-v1alpha2-kops)* |
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## AuthorizationSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | AuthorizationSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
alwaysAllow <br /> *[AlwaysAllowAuthorizationSpec](#alwaysallowauthorizationspec-v1alpha2-kops)* |
|
||||
rbac <br /> *[RBACAuthorizationSpec](#rbacauthorizationspec-v1alpha2-kops)* |
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## BastionSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | BastionSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#topologyspec-v1alpha2-kops">TopologySpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
bastionPublicName <br /> *string* |
|
||||
idleTimeoutSeconds <br /> *integer* | IdleTimeoutSeconds is the bastion's Loadbalancer idle timeout
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## CalicoNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | CalicoNetworkingSpec
|
||||
|
||||
|
||||
|
||||
CalicoNetworkingSpec declares that we want Calico networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
crossSubnet <br /> *boolean* |
|
||||
logSeverityScreen <br /> *string* | LogSeverityScreen lets us set the desired log level. (Default: info)
|
||||
prometheusGoMetricsEnabled <br /> *boolean* | PrometheusGoMetricsEnabled enables Prometheus Go runtime metrics collection
|
||||
prometheusMetricsEnabled <br /> *boolean* | PrometheusMetricsEnabled can be set to enable the experimental Prometheus metrics server (default: false)
|
||||
prometheusMetricsPort <br /> *integer* | PrometheusMetricsPort is the TCP port that the experimental Prometheus metrics server should bind to (default: 9091)
|
||||
prometheusProcessMetricsEnabled <br /> *boolean* | PrometheusProcessMetricsEnabled enables Prometheus process metrics collection
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## CanalNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | CanalNetworkingSpec
|
||||
|
||||
|
||||
|
||||
CanalNetworkingSpec declares that we want Canal networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
chainInsertMode <br /> *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 <br /> *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 <br /> *boolean* | PrometheusGoMetricsEnabled enables Prometheus Go runtime metrics collection
|
||||
prometheusMetricsEnabled <br /> *boolean* | PrometheusMetricsEnabled can be set to enable the experimental Prometheus metrics server (default: false)
|
||||
prometheusMetricsPort <br /> *integer* | PrometheusMetricsPort is the TCP port that the experimental Prometheus metrics server should bind to (default: 9091)
|
||||
prometheusProcessMetricsEnabled <br /> *boolean* | PrometheusProcessMetricsEnabled enables Prometheus process metrics collection
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## CiliumNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | CiliumNetworkingSpec
|
||||
|
||||
|
||||
|
||||
CiliumNetworkingSpec declares that we want Cilium networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
debug <br /> *boolean* |
|
||||
tunnel <br /> *string* |
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## ClassicNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | ClassicNetworkingSpec
|
||||
|
||||
|
||||
|
||||
ClassicNetworkingSpec is the specification of classic networking mode, integrated into kubernetes
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
## CloudConfiguration v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | CloudConfiguration
|
||||
|
||||
|
||||
|
||||
CloudConfiguration defines the cloud provider configuration
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
disableSecurityGroupIngress <br /> *boolean* | AWS cloud-config options
|
||||
elbSecurityGroup <br /> *string* |
|
||||
multizone <br /> *boolean* | GCE cloud-config options
|
||||
nodeInstancePrefix <br /> *string* |
|
||||
nodeTags <br /> *string* |
|
||||
vSphereCoreDNSServer <br /> *string* |
|
||||
vSphereDatacenter <br /> *string* |
|
||||
vSphereDatastore <br /> *string* |
|
||||
vSpherePassword <br /> *string* |
|
||||
vSphereResourcePool <br /> *string* |
|
||||
vSphereServer <br /> *string* |
|
||||
vSphereUsername <br /> *string* | vSphere cloud-config specs
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
## CloudControllerManagerConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | CloudControllerManagerConfig
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
allocateNodeCIDRs <br /> *boolean* | AllocateNodeCIDRs enables CIDRs for Pods to be allocated and, if ConfigureCloudRoutes is true, to be set on the cloud provider.
|
||||
cidrAllocatorType <br /> *string* | CIDRAllocatorType specifies the type of CIDR allocator to use.
|
||||
cloudProvider <br /> *string* | CloudProvider is the provider for cloud services.
|
||||
clusterCIDR <br /> *string* | ClusterCIDR is CIDR Range for Pods in cluster.
|
||||
clusterName <br /> *string* | ClusterName is the instance prefix for the cluster.
|
||||
configureCloudRoutes <br /> *boolean* | ConfigureCloudRoutes enables CIDRs allocated with to be configured on the cloud provider.
|
||||
image <br /> *string* | Image is the OCI image of the cloud controller manager.
|
||||
leaderElection <br /> *[LeaderElectionConfiguration](#leaderelectionconfiguration-v1alpha2-kops)* | LeaderElection defines the configuration of leader election client.
|
||||
logLevel <br /> *integer* | LogLevel is the verbosity of the logs.
|
||||
master <br /> *string* | Master is the url for the kube api master.
|
||||
useServiceAccountCredentials <br /> *boolean* | UseServiceAccountCredentials controls whether we use individual service account credentials for each controller.
|
||||
|
||||
|
|
@ -0,0 +1,183 @@
|
|||
|
||||
|
||||
-----------
|
||||
# Cluster v1alpha2 kops
|
||||
|
||||
>bdocs-tab:example
|
||||
|
||||
```bdocs-tab:example_yaml
|
||||
|
||||
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
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterlist-v1alpha2-kops">ClusterList kops/v1alpha2</a></li>
|
||||
</ul> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *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 <br /> *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 <br /> *[ObjectMeta](#objectmeta-v1-meta)* |
|
||||
spec <br /> *[ClusterSpec](#clusterspec-v1alpha2-kops)* |
|
||||
|
||||
|
||||
### ClusterSpec v1alpha2 kops
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#cluster-v1alpha2-kops">Cluster kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
additionalNetworkCIDRs <br /> *string array* | AdditionalNetworkCIDRs is a list of aditional 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 aditional CIDRs added to a VPC.
|
||||
additionalPolicies <br /> *object* | Additional policies to add for roles
|
||||
additionalSans <br /> *string array* | AdditionalSANs adds additional Subject Alternate Names to apiserver cert that kops generates
|
||||
addons <br /> *[AddonSpec](#addonspec-v1alpha2-kops) array* | Additional addons that should be installed on the cluster
|
||||
api <br /> *[AccessSpec](#accessspec-v1alpha2-kops)* | API field controls how the API is exposed outside the cluster
|
||||
assets <br /> *[Assets](#assets-v1alpha2-kops)* | Alternative locations for files and containers
|
||||
authentication <br /> *[AuthenticationSpec](#authenticationspec-v1alpha2-kops)* | Authentication field controls how the cluster is configured for authentication
|
||||
authorization <br /> *[AuthorizationSpec](#authorizationspec-v1alpha2-kops)* | Authorization field controls how the cluster is configured for authorization
|
||||
channel <br /> *string* | The Channel we are following
|
||||
cloudConfig <br /> *[CloudConfiguration](#cloudconfiguration-v1alpha2-kops)* |
|
||||
cloudControllerManager <br /> *[CloudControllerManagerConfig](#cloudcontrollermanagerconfig-v1alpha2-kops)* |
|
||||
cloudLabels <br /> *object* | Tags for AWS resources
|
||||
cloudProvider <br /> *string* | The CloudProvider to use (aws or gce)
|
||||
clusterDNSDomain <br /> *string* | ClusterDNSDomain is the suffix we use for internal DNS names (normally cluster.local)
|
||||
configBase <br /> *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 <br /> *string* | ConfigStore is the VFS path to where the configuration (Cluster, InstanceGroups etc) is stored
|
||||
dnsZone <br /> *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 <br /> *[DockerConfig](#dockerconfig-v1alpha2-kops)* | Component configurations
|
||||
egressProxy <br /> *[EgressProxySpec](#egressproxyspec-v1alpha2-kops)* | HTTPProxy defines connection information to support use of a private cluster behind an forward HTTP Proxy
|
||||
encryptionConfig <br /> *boolean* | EncryptionConfig holds the encryption config
|
||||
etcdClusters <br /> *[EtcdClusterSpec](#etcdclusterspec-v1alpha2-kops) array* | EtcdClusters stores the configuration for each cluster
|
||||
externalDns <br /> *[ExternalDNSConfig](#externaldnsconfig-v1alpha2-kops)* |
|
||||
fileAssets <br /> *[FileAssetSpec](#fileassetspec-v1alpha2-kops) array* | A collection of files assets for deployed cluster wide
|
||||
hooks <br /> *[HookSpec](#hookspec-v1alpha2-kops) array* | Hooks for custom actions e.g. on first installation
|
||||
iam <br /> *[IAMSpec](#iamspec-v1alpha2-kops)* | IAM field adds control over the IAM security policies applied to resources
|
||||
isolateMasters <br /> *boolean* | IsolatesMasters 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 <br /> *string* | KeyStore is the VFS path to where SSL keys and certificates are stored
|
||||
kubeAPIServer <br /> *[KubeAPIServerConfig](#kubeapiserverconfig-v1alpha2-kops)* |
|
||||
kubeControllerManager <br /> *[KubeControllerManagerConfig](#kubecontrollermanagerconfig-v1alpha2-kops)* |
|
||||
kubeDNS <br /> *[KubeDNSConfig](#kubednsconfig-v1alpha2-kops)* |
|
||||
kubeProxy <br /> *[KubeProxyConfig](#kubeproxyconfig-v1alpha2-kops)* |
|
||||
kubeScheduler <br /> *[KubeSchedulerConfig](#kubeschedulerconfig-v1alpha2-kops)* |
|
||||
kubelet <br /> *[KubeletConfigSpec](#kubeletconfigspec-v1alpha2-kops)* |
|
||||
kubernetesApiAccess <br /> *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 <br /> *string* | The version of kubernetes to install (optional, and can be a "spec" like stable)
|
||||
masterInternalName <br /> *string* | MasterInternalName is the internal DNS name for the master nodes
|
||||
masterKubelet <br /> *[KubeletConfigSpec](#kubeletconfigspec-v1alpha2-kops)* |
|
||||
masterPublicName <br /> *string* | MasterPublicName is the external DNS name for the master nodes
|
||||
networkCIDR <br /> *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 <br /> *string* | NetworkID is an identifier of a network, if we want to reuse/share an existing network (e.g. an AWS VPC)
|
||||
networking <br /> *[NetworkingSpec](#networkingspec-v1alpha2-kops)* | Networking configuration
|
||||
nodePortAccess <br /> *string array* | NodePortAccess is a list of the CIDRs that can access the node ports range (30000-32767).
|
||||
nonMasqueradeCIDR <br /> *string* | MasterIPRange string `json:",omitempty"` NonMasqueradeCIDR is the CIDR for the internal k8s network (on which pods & services live) It cannot overlap ServiceClusterIPRange
|
||||
project <br /> *string* | Project is the cloud project we should use, required on GCE
|
||||
secretStore <br /> *string* | SecretStore is the VFS path to where secrets are stored
|
||||
serviceClusterIPRange <br /> *string* | ServiceClusterIPRange is the CIDR, from the internal network, where we allocate IPs for services
|
||||
sshAccess <br /> *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 <br /> *string* | SSHKeyName specifies a preexisting SSH key to use
|
||||
subnets <br /> *[ClusterSubnetSpec](#clustersubnetspec-v1alpha2-kops) array* | Configuration of subnets we are targeting
|
||||
target <br /> *[TargetSpec](#targetspec-v1alpha2-kops)* | Target allows for us to nest extra config for targets such as terraform
|
||||
topology <br /> *[TopologySpec](#topologyspec-v1alpha2-kops)* | 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 <br /> *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 <br /> *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 <br /> *[Cluster](#cluster-v1alpha2-kops) array* |
|
||||
kind <br /> *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 <br /> *[ListMeta](#listmeta-v1-meta)* |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
## ClusterSubnetSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | ClusterSubnetSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
cidr <br /> *string* |
|
||||
egress <br /> *string* | Egress defines the method of traffic egress for this subnet
|
||||
id <br /> *string* | ProviderID is the cloud provider id for the objects associated with the zone (the subnet on AWS)
|
||||
name <br /> *string* |
|
||||
publicIP <br /> *string* | PublicIP to attatch to NatGateway
|
||||
region <br /> *string* | Region is the region the subnet is in, set for subnets that are regionally scoped
|
||||
type <br /> *string* |
|
||||
zone <br /> *string* | Zone is the zone the subnet is in, set for subnets that are zonally scoped
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## DeleteOptions v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | DeleteOptions
|
||||
|
||||
|
||||
|
||||
DeleteOptions may be provided when deleting an API object.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *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 <br /> *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 <br /> *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 <br /> *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 <br /> *[Preconditions](#preconditions-v1-meta)* | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
|
||||
propagationPolicy <br /> *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.
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## DNSAccessSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | DNSAccessSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#accessspec-v1alpha2-kops">AccessSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## DNSSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | DNSSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#topologyspec-v1alpha2-kops">TopologySpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
type <br /> *string* |
|
||||
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
## DockerConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | DockerConfig
|
||||
|
||||
|
||||
|
||||
DockerConfig is the configuration for docker
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
authorizationPlugins <br /> *string array* | AuthorizationPlugins is a list of authorization plugins
|
||||
bridge <br /> *string* | Bridge is the network interface containers should bind onto
|
||||
bridgeIP <br /> *string* | BridgeIP is a specific IP address and netmask for the docker0 bridge, using standard CIDR notation
|
||||
defaultUlimit <br /> *string array* | DefaultUlimit is the ulimits for containers
|
||||
hosts <br /> *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 <br /> *string* | InsecureRegistry enable insecure registry communication @question according to dockers this a list??
|
||||
ipMasq <br /> *boolean* | IPMasq enables ip masquerading for containers
|
||||
ipTables <br /> *boolean* | IPtables enables addition of iptables rules
|
||||
liveRestore <br /> *boolean* | LiveRestore enables live restore of docker when containers are still running
|
||||
logDriver <br /> *string* | LogDriver is the default driver for container logs (default "json-file")
|
||||
logLevel <br /> *string* | LogLevel is the logging level ("debug", "info", "warn", "error", "fatal") (default "info")
|
||||
logOpt <br /> *string array* | Logopt is a series of options given to the log driver options for containers
|
||||
mtu <br /> *integer* | MTU is the containers network MTU
|
||||
registryMirrors <br /> *string array* | RegistryMirrors is a referred list of docker registry mirror
|
||||
storage <br /> *string* | Storage is the docker storage driver to use
|
||||
storageOpts <br /> *string array* | StorageOpts is a series of options passed to the storage driver
|
||||
version <br /> *string* | Version is consumed by the nodeup and used to pick the docker version
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#etcdclusterspec-v1alpha2-kops">EtcdClusterSpec kops/v1alpha2</a></li>
|
||||
<li><a href="#kubeapiserverconfig-v1alpha2-kops">KubeAPIServerConfig kops/v1alpha2</a></li>
|
||||
<li><a href="#kubecontrollermanagerconfig-v1alpha2-kops">KubeControllerManagerConfig kops/v1alpha2</a></li>
|
||||
<li><a href="#kubeletconfigspec-v1alpha2-kops">KubeletConfigSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
Duration <br /> *integer* |
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## EgressProxySpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | EgressProxySpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
excludes <br /> *string* |
|
||||
httpProxy <br /> *[HTTPProxy](#httpproxy-v1alpha2-kops)* |
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## EtcdBackupSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | EtcdBackupSpec
|
||||
|
||||
|
||||
|
||||
EtcdBackupSpec describes how we want to do backups of etcd
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#etcdclusterspec-v1alpha2-kops">EtcdClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
backupStore <br /> *string* | BackupStore is the VFS path where we will read/write backup data
|
||||
image <br /> *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.
|
||||
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
## EtcdClusterSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | EtcdClusterSpec
|
||||
|
||||
|
||||
|
||||
EtcdClusterSpec is the etcd cluster specification
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
backups <br /> *[EtcdBackupSpec](#etcdbackupspec-v1alpha2-kops)* | Backups describes how we do backups of etcd
|
||||
enableEtcdTLS <br /> *boolean* | EnableEtcdTLS indicates the etcd service should use TLS between peers and clients
|
||||
enableTLSAuth <br /> *boolean* | EnableTLSAuth indicates client and peer TLS auth should be enforced
|
||||
etcdMembers <br /> *[EtcdMemberSpec](#etcdmemberspec-v1alpha2-kops) array* | Members stores the configurations for each member of the cluster (including the data volume)
|
||||
heartbeatInterval <br /> *[Duration](#duration-v1-meta)* | HeartbeatInterval is the time (in milliseconds) for an etcd heartbeat interval
|
||||
image <br /> *string* | Image is the etcd docker image to use. Setting this will ignore the Version specified.
|
||||
leaderElectionTimeout <br /> *[Duration](#duration-v1-meta)* | LeaderElectionTimeout is the time (in milliseconds) for an etcd leader election timeout
|
||||
name <br /> *string* | Name is the name of the etcd cluster (main, events etc)
|
||||
version <br /> *string* | Version is the version of etcd to run i.e. 2.1.2, 3.0.17 etcd
|
||||
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
## EtcdMemberSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | EtcdMemberSpec
|
||||
|
||||
|
||||
|
||||
EtcdMemberSpec is a specification for a etcd member
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#etcdclusterspec-v1alpha2-kops">EtcdClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
encryptedVolume <br /> *boolean* | EncryptedVolume indicates you want to encrypt the volume
|
||||
instanceGroup <br /> *string* | InstanceGroup is the instanceGroup this volume is associated
|
||||
kmsKeyId <br /> *string* | KmsKeyId is a AWS KMS ID used to encrypt the volume
|
||||
name <br /> *string* | Name is the name of the member within the etcd cluster
|
||||
volumeIops <br /> *integer* | If volume type is io1, then we need to specify the number of Iops.
|
||||
volumeSize <br /> *integer* | VolumeSize is the underlining cloud volume size
|
||||
volumeType <br /> *string* | VolumeType is the underlining cloud storage class
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
## ExecContainerAction v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | ExecContainerAction
|
||||
|
||||
|
||||
|
||||
ExecContainerAction defines an hood action
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#hookspec-v1alpha2-kops">HookSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
command <br /> *string array* | Command is the command supplied to the above image
|
||||
environment <br /> *object* | Environment is a map of environment variables added to the hook
|
||||
image <br /> *string* | Image is the docker image
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
## ExternalDNSConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | ExternalDNSConfig
|
||||
|
||||
|
||||
|
||||
ExternalDNSConfig are options of the dns-controller
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
disable <br /> *boolean* | Disable indicates we do not wish to run the dns-controller addon
|
||||
watchIngress <br /> *boolean* | WatchIngress indicates you want the dns-controller to watch and create dns entries for ingress resources
|
||||
watchNamespace <br /> *string* | WatchNamespace is namespace to watch, detaults to all (use to control whom can creates dns entries)
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## 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
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## FileAssetSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | FileAssetSpec
|
||||
|
||||
|
||||
|
||||
FileAssetSpec defines the structure for a file asset
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
<li><a href="#instancegroupspec-v1alpha2-kops">InstanceGroupSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
content <br /> *string* | Content is the contents of the file
|
||||
isBase64 <br /> *boolean* | IsBase64 indicates the contents is base64 encoded
|
||||
name <br /> *string* | Name is a shortened reference to the asset
|
||||
path <br /> *string* | Path is the location this file should reside
|
||||
roles <br /> *string array* | Roles is a list of roles the file asset should be applied, defaults to all
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## FlannelNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | FlannelNetworkingSpec
|
||||
|
||||
|
||||
|
||||
FlannelNetworkingSpec declares that we want Flannel networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
backend <br /> *string* | Backend is the backend overlay type we want to use (vxlan or udp)
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#apigroup-v1-meta">APIGroup meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groupVersion <br /> *string* | groupVersion specifies the API group and version in the form "group/version"
|
||||
version <br /> *string* | version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
|
||||
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
## HookSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | HookSpec
|
||||
|
||||
|
||||
|
||||
HookSpec is a definition hook
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
<li><a href="#instancegroupspec-v1alpha2-kops">InstanceGroupSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
before <br /> *string array* | Before is a series of systemd units which this hook must run before
|
||||
disabled <br /> *boolean* | Disabled indicates if you want the unit switched off
|
||||
execContainer <br /> *[ExecContainerAction](#execcontaineraction-v1alpha2-kops)* | ExecContainer is the image itself
|
||||
manifest <br /> *string* | Manifest is a raw systemd unit file
|
||||
name <br /> *string* | Name is an optional name for the hook, otherwise the name is kops-hook-<index>
|
||||
requires <br /> *string array* | Requires is a series of systemd units the action requires
|
||||
roles <br /> *string array* | Roles is an optional list of roles the hook should be rolled out to, defaults to all
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## HTTPProxy v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | HTTPProxy
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#egressproxyspec-v1alpha2-kops">EgressProxySpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
host <br /> *string* |
|
||||
port <br /> *integer* |
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## IAMSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | IAMSpec
|
||||
|
||||
|
||||
|
||||
IAMSpec adds control over the IAM security policies applied to resources
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
allowContainerRegistry <br /> *boolean* |
|
||||
legacy <br /> *boolean* |
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## Initializer v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | Initializer
|
||||
|
||||
|
||||
|
||||
Initializer is information about an initializer that has not yet completed.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#initializers-v1-meta">Initializers meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | name of the process that is responsible for initializing this object.
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## Initializers v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | Initializers
|
||||
|
||||
|
||||
|
||||
Initializers tracks the progress of initialization.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#objectmeta-v1-meta">ObjectMeta meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
pending <br /> *[Initializer](#initializer-v1-meta) array* <br /> **patch type**: *merge* <br /> **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 <br /> *[Status](#status-v1-meta)* | 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.
|
||||
|
||||
|
|
@ -0,0 +1,118 @@
|
|||
|
||||
|
||||
-----------
|
||||
# InstanceGroup v1alpha2 kops
|
||||
|
||||
>bdocs-tab:example
|
||||
|
||||
```bdocs-tab:example_yaml
|
||||
|
||||
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
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#instancegrouplist-v1alpha2-kops">InstanceGroupList kops/v1alpha2</a></li>
|
||||
</ul> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *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 <br /> *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 <br /> *[ObjectMeta](#objectmeta-v1-meta)* |
|
||||
spec <br /> *[InstanceGroupSpec](#instancegroupspec-v1alpha2-kops)* |
|
||||
|
||||
|
||||
### InstanceGroupSpec v1alpha2 kops
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#instancegroup-v1alpha2-kops">InstanceGroup kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
additionalSecurityGroups <br /> *string array* | AdditionalSecurityGroups attaches additional security groups (e.g. i-123456)
|
||||
additionalUserData <br /> *[UserData](#userdata-v1alpha2-kops) array* | AdditionalUserData is any aditional user-data to be passed to the host
|
||||
associatePublicIp <br /> *boolean* | AssociatePublicIP is true if we want instances to have a public IP
|
||||
cloudLabels <br /> *object* | CloudLabels indicates the labels for instances in this group, at the AWS level
|
||||
detailedInstanceMonitoring <br /> *boolean* | DetailedInstanceMonitoring defines if detailed-monitoring is enabled (AWS only)
|
||||
fileAssets <br /> *[FileAssetSpec](#fileassetspec-v1alpha2-kops) array* | FileAssets is a collection of file assets for this instance group
|
||||
hooks <br /> *[HookSpec](#hookspec-v1alpha2-kops) array* | Hooks is a list of hooks for this instanceGroup, note: these can override the cluster wide ones if required
|
||||
image <br /> *string* | Image is the instance instance (ami etc) we should use
|
||||
kubelet <br /> *[KubeletConfigSpec](#kubeletconfigspec-v1alpha2-kops)* | Kubelet overrides kubelet config from the ClusterSpec
|
||||
machineType <br /> *string* | MachineType is the instance class
|
||||
maxPrice <br /> *string* | MaxPrice indicates this is a spot-pricing group, with the specified value as our max-price bid
|
||||
maxSize <br /> *integer* | MaxSize is the maximum size of the pool
|
||||
minSize <br /> *integer* | MinSize is the minimum size of the pool
|
||||
nodeLabels <br /> *object* | NodeLabels indicates the kubernetes labels for nodes in this group
|
||||
role <br /> *string* | Type determines the role of instances in this group: masters or nodes
|
||||
rootVolumeIops <br /> *integer* | If volume type is io1, then we need to specify the number of Iops.
|
||||
rootVolumeOptimization <br /> *boolean* | RootVolumeOptimization enables EBS optimization for an instance
|
||||
rootVolumeSize <br /> *integer* | RootVolumeSize is the size of the EBS root volume to use, in GB
|
||||
rootVolumeType <br /> *string* | RootVolumeType is the type of the EBS root volume to use (e.g. gp2)
|
||||
subnets <br /> *string array* | Subnets is the names of the Subnets (as specified in the Cluster) where machines in this instance group should be placed
|
||||
suspendProcesses <br /> *string array* | SuspendProcesses disables the listed Scaling Policies
|
||||
taints <br /> *string array* | Taints indicates the kubernetes taints for nodes in this group
|
||||
tenancy <br /> *string* | Describes the tenancy of the instance group. Can be either default or dedicated. Currently only applies to AWS.
|
||||
zones <br /> *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 <br /> *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 <br /> *[InstanceGroup](#instancegroup-v1alpha2-kops) array* |
|
||||
kind <br /> *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 <br /> *[ListMeta](#listmeta-v1-meta)* |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## KopeioAuthenticationSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KopeioAuthenticationSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#authenticationspec-v1alpha2-kops">AuthenticationSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## KopeioNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KopeioNetworkingSpec
|
||||
|
||||
|
||||
|
||||
KopeioNetworkingSpec declares that we want Kopeio networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,75 @@
|
|||
## KubeAPIServerConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KubeAPIServerConfig
|
||||
|
||||
|
||||
|
||||
KubeAPIServerConfig defines the configuration for the kube api
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
address <br /> *string* | Address is the binding address for the kube api
|
||||
admissionControl <br /> *string array* | AdmissionControl is a list of admission controllers to user
|
||||
allowPrivileged <br /> *boolean* | AllowPrivileged indicates if we can run privileged containers
|
||||
anonymousAuth <br /> *boolean* | AnonymousAuth indicates if anonymous authentication is permitted
|
||||
apiServerCount <br /> *integer* | APIServerCount is the number of api servers
|
||||
auditLogFormat <br /> *string* | AuditLogFormat flag specifies the format type for audit log files.
|
||||
auditLogMaxAge <br /> *integer* | The maximum number of days to retain old audit log files based on the timestamp encoded in their filename.
|
||||
auditLogMaxBackups <br /> *integer* | The maximum number of old audit log files to retain.
|
||||
auditLogMaxSize <br /> *integer* | The maximum size in megabytes of the audit log file before it gets rotated. Defaults to 100MB.
|
||||
auditLogPath <br /> *string* | If set, all requests coming to the apiserver will be logged to this file.
|
||||
auditPolicyFile <br /> *string* | AuditPolicyFile is the full path to a advanced audit configuration file a.g. /srv/kubernetes/audit.conf
|
||||
authenticationTokenWebhookCacheTtl <br /> *[Duration](#duration-v1-meta)* | The duration to cache responses from the webhook token authenticator. Default is 2m. (default 2m0s)
|
||||
authenticationTokenWebhookConfigFile <br /> *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 <br /> *string* | AuthorizationMode is the authorization mode the kubeapi is running in
|
||||
authorizationRbacSuperUser <br /> *string* | AuthorizationRBACSuperUser is the name of the superuser for default rbac
|
||||
basicAuthFile <br /> *string* |
|
||||
clientCAFile <br /> *string* |
|
||||
cloudProvider <br /> *string* | CloudProvider is the name of the cloudProvider we are using, aws, gce etcd
|
||||
etcdCaFile <br /> *string* | EtcdCAFile is the path to a ca certificate
|
||||
etcdCertFile <br /> *string* | EtcdCertFile is the path to a certificate
|
||||
etcdKeyFile <br /> *string* | EtcdKeyFile is the path to a private key
|
||||
etcdQuorumRead <br /> *boolean* | EtcdQuorumRead configures the etcd-quorum-read flag, which forces consistent reads from etcd
|
||||
etcdServers <br /> *string array* | EtcdServers is a list of the etcd service to connect
|
||||
etcdServersOverrides <br /> *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 <br /> *string* | ExperimentalEncryptionProviderConfig enables encryption at rest for secrets.
|
||||
featureGates <br /> *object* | FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
|
||||
image <br /> *string* | Image is the docker container used
|
||||
insecurePort <br /> *integer* | InsecurePort is the port the insecure api runs
|
||||
kubeletClientCertificate <br /> *string* | KubeletClientCertificate is the path of a certificate for secure communication between api and kubelet
|
||||
kubeletClientKey <br /> *string* | KubeletClientKey is the path of a private to secure communication between api and kubelet
|
||||
kubeletPreferredAddressTypes <br /> *string array* | KubeletPreferredAddressTypes is a list of the preferred NodeAddressTypes to use for kubelet connections
|
||||
logLevel <br /> *integer* | LogLevel is the logging level of the api
|
||||
maxRequestsInflight <br /> *integer* | MaxRequestsInflight The maximum number of non-mutating requests in flight at a given time.
|
||||
oidcCAFile <br /> *string* | OIDCCAFile if set, the OpenID server's certificate will be verified by one of the authorities in the oidc-ca-file
|
||||
oidcClientID <br /> *string* | OIDCClientID is the client ID for the OpenID Connect client, must be set if oidc-issuer-url is set.
|
||||
oidcGroupsClaim <br /> *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 <br /> *string* | OIDCGroupsPrefix is the prefix prepended to group claims to prevent clashes with existing names (such as 'system:' groups)
|
||||
oidcIssuerURL <br /> *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 <br /> *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 <br /> *string* | OIDCUsernamePrefix is the prefix prepended to username claims to prevent clashes with existing names (such as 'system:' users).
|
||||
proxyClientCertFile <br /> *string* | The apiserver's client certificate used for outbound requests.
|
||||
proxyClientKeyFile <br /> *string* | The apiserver's client key used for outbound requests.
|
||||
requestheaderAllowedNames <br /> *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 <br /> *string* | Root certificate bundle to use to verify client certificates on incoming requests before trusting usernames in headers specified by --requestheader-username-headers
|
||||
requestheaderExtraHeaderPrefixes <br /> *string array* | List of request header prefixes to inspect. X-Remote-Extra- is suggested.
|
||||
requestheaderGroupHeaders <br /> *string array* | List of request headers to inspect for groups. X-Remote-Group is suggested.
|
||||
requestheaderUsernameHeaders <br /> *string array* | List of request headers to inspect for usernames. X-Remote-User is common.
|
||||
runtimeConfig <br /> *object* | RuntimeConfig is a series of keys/values are parsed into the `--runtime-config` parameters
|
||||
securePort <br /> *integer* | SecurePort is the port the kube runs on
|
||||
serviceClusterIPRange <br /> *string* | ServiceClusterIPRange is the service address range
|
||||
serviceNodePortRange <br /> *string* | Passed as --service-node-port-range to kube-apiserver. Expects 'startPort-endPort' format. Eg. 30000-33000
|
||||
storageBackend <br /> *string* | StorageBackend is the backend storage
|
||||
tlsCertFile <br /> *string* |
|
||||
tlsPrivateKeyFile <br /> *string* |
|
||||
tokenAuthFile <br /> *string* |
|
||||
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
## KubeControllerManagerConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KubeControllerManagerConfig
|
||||
|
||||
|
||||
|
||||
KubeControllerManagerConfig is the configuration for the controller
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
allocateNodeCIDRs <br /> *boolean* | AllocateNodeCIDRs enables CIDRs for Pods to be allocated and, if ConfigureCloudRoutes is true, to be set on the cloud provider.
|
||||
attachDetachReconcileSyncPeriod <br /> *[Duration](#duration-v1-meta)* | 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 <br /> *string* | CIDRAllocatorType specifies the type of CIDR allocator to use.
|
||||
cloudProvider <br /> *string* | CloudProvider is the provider for cloud services.
|
||||
clusterCIDR <br /> *string* | ClusterCIDR is CIDR Range for Pods in cluster.
|
||||
clusterName <br /> *string* | ClusterName is the instance prefix for the cluster.
|
||||
configureCloudRoutes <br /> *boolean* | ConfigureCloudRoutes enables CIDRs allocated with to be configured on the cloud provider.
|
||||
featureGates <br /> *object* | FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
|
||||
horizontalPodAutoscalerDownscaleDelay <br /> *[Duration](#duration-v1-meta)* | 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 <br /> *[Duration](#duration-v1-meta)* | 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 <br /> *[Duration](#duration-v1-meta)* | 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 <br /> *boolean* | HorizontalPodAutoscalerUseRestClients determines if the new-style clients should be used if support for custom metrics is enabled.
|
||||
image <br /> *string* | Image is the docker image to use
|
||||
leaderElection <br /> *[LeaderElectionConfiguration](#leaderelectionconfiguration-v1alpha2-kops)* | LeaderElection defines the configuration of leader election client.
|
||||
logLevel <br /> *integer* | LogLevel is the defined logLevel
|
||||
master <br /> *string* | Master is the url for the kube api master
|
||||
nodeMonitorGracePeriod <br /> *[Duration](#duration-v1-meta)* | 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 <br /> *[Duration](#duration-v1-meta)* | NodeMonitorPeriod is the period for syncing NodeStatus in NodeController. (default 5s)
|
||||
podEvictionTimeout <br /> *[Duration](#duration-v1-meta)* | PodEvictionTimeout is the grace period for deleting pods on failed nodes. (default 5m0s)
|
||||
rootCAFile <br /> *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 <br /> *string* | ServiceAccountPrivateKeyFile the location for a certificate for service account signing
|
||||
terminatedPodGCThreshold <br /> *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 <br /> *boolean* | UseServiceAccountCredentials controls whether we use individual service account credentials for each controller.
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## KubeDNSConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KubeDNSConfig
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
cacheMaxConcurrent <br /> *integer* | CacheMaxConcurrent is the maximum number of concurrent queries for dnsmasq
|
||||
cacheMaxSize <br /> *integer* | CacheMaxSize is the maximum entries to keep in dnsmaq
|
||||
domain <br /> *string* |
|
||||
image <br /> *string* | Image is the name of the docker image to run Deprecated as this is now in the addon
|
||||
replicas <br /> *integer* | Deprecated as this is now in the addon, and controlled by autoscaler
|
||||
serverIP <br /> *string* |
|
||||
|
||||
|
|
@ -0,0 +1,79 @@
|
|||
## KubeletConfigSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KubeletConfigSpec
|
||||
|
||||
|
||||
|
||||
KubeletConfigSpec defines the kubelet configuration
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
<li><a href="#instancegroupspec-v1alpha2-kops">InstanceGroupSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
allowPrivileged <br /> *boolean* | AllowPrivileged enables containers to request privileged mode (defaults to false)
|
||||
anonymousAuth <br /> *boolean* | AnonymousAuth permits you to control auth to the kubelet api
|
||||
apiServers <br /> *string* | APIServers is not used for clusters version 1.6 and later - flag removed
|
||||
authorizationMode <br /> *string* | AuthorizationMode is the authorization mode the kubelet is running in
|
||||
babysitDaemons <br /> *boolean* | The node has babysitter process monitoring docker and kubelet. Removed as of 1.7
|
||||
cgroupRoot <br /> *string* | cgroupRoot is the root cgroup to use for pods. This is handled by the container runtime on a best effort basis.
|
||||
clientCaFile <br /> *string* | ClientCAFile is the path to a CA certificate
|
||||
cloudProvider <br /> *string* | CloudProvider is the provider for cloud services.
|
||||
clusterDNS <br /> *string* | ClusterDNS is the IP address for a cluster DNS server
|
||||
clusterDomain <br /> *string* | ClusterDomain is the DNS domain for this cluster
|
||||
configureCbr0 <br /> *boolean* | configureCBR0 enables the kublet to configure cbr0 based on Node.Spec.PodCIDR.
|
||||
enableCustomMetrics <br /> *boolean* | Enable gathering custom metrics.
|
||||
enableDebuggingHandlers <br /> *boolean* | EnableDebuggingHandlers enables server endpoints for log collection and local running of containers and commands
|
||||
enforceNodeAllocatable <br /> *string* | Enforce Allocatable across pods whenever the overall usage across all pods exceeds Allocatable.
|
||||
evictionHard <br /> *string* | Comma-delimited list of hard eviction expressions. For example, 'memory.available<300Mi'.
|
||||
evictionMaxPodGracePeriod <br /> *integer* | Maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met.
|
||||
evictionMinimumReclaim <br /> *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 <br /> *[Duration](#duration-v1-meta)* | Duration for which the kubelet has to wait before transitioning out of an eviction pressure condition.
|
||||
evictionSoft <br /> *string* | Comma-delimited list of soft eviction expressions. For example, 'memory.available<300Mi'.
|
||||
evictionSoftGracePeriod <br /> *string* | Comma-delimited list of grace periods for each soft eviction signal. For example, 'memory.available=30s'.
|
||||
failSwapOn <br /> *boolean* | Tells the Kubelet to fail to start if swap is enabled on the node.
|
||||
featureGates <br /> *object* | FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
|
||||
hairpinMode <br /> *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 <br /> *string* | HostnameOverride is the hostname used to identify the kubelet instead of the actual hostname.
|
||||
imageGCHighThresholdPercent <br /> *integer* | ImageGCHighThresholdPercent is the percent of disk usage after which image garbage collection is always run.
|
||||
imageGCLowThresholdPercent <br /> *integer* | ImageGCLowThresholdPercent is the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to.
|
||||
imagePullProgressDeadline <br /> *[Duration](#duration-v1-meta)* | 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 <br /> *object* | Resource reservation for kubernetes system daemons like the kubelet, container runtime, node problem detector, etc.
|
||||
kubeReservedCgroup <br /> *string* | Control group for kube daemons.
|
||||
kubeconfigPath <br /> *string* | KubeconfigPath is the path of kubeconfig for the kubelet
|
||||
kubeletCgroups <br /> *string* | KubeletCgroups is the absolute name of cgroups to isolate the kubelet in.
|
||||
logLevel <br /> *integer* | LogLevel is the logging level of the kubelet
|
||||
maxPods <br /> *integer* | MaxPods is the number of pods that can run on this Kubelet.
|
||||
networkPluginMTU <br /> *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 <br /> *string* | NetworkPluginName is the name of the network plugin to be invoked for various events in kubelet/pod lifecycle
|
||||
nodeLabels <br /> *object* | NodeLabels to add when registering the node in the cluster.
|
||||
nodeStatusUpdateFrequency <br /> *[Duration](#duration-v1-meta)* | NodeStatusUpdateFrequency Specifies how often kubelet posts node status to master (default 10s) must work with nodeMonitorGracePeriod in KubeControllerManagerConfig.
|
||||
nonMasqueradeCIDR <br /> *string* | NonMasqueradeCIDR configures masquerading: traffic to IPs outside this range will use IP masquerade.
|
||||
nvidiaGPUs <br /> *integer* | NvidiaGPUs is the number of NVIDIA GPU devices on this node.
|
||||
podCIDR <br /> *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 <br /> *string* | PodInfraContainerImage is the image whose network/ipc containers in each pod will use.
|
||||
podManifestPath <br /> *string* | config is the path to the config file or directory of files
|
||||
readOnlyPort <br /> *integer* | ReadOnlyPort is the port used by the kubelet api for read-only access (default 10255)
|
||||
reconcileCIDR <br /> *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 <br /> *boolean* | RegisterNode enables automatic registration with the apiserver.
|
||||
registerSchedulable <br /> *boolean* | registerSchedulable tells the kubelet to register the node as schedulable. No-op if register-node is false.
|
||||
requireKubeconfig <br /> *boolean* | RequireKubeconfig indicates a kubeconfig is required
|
||||
resolvConf <br /> *string* | ResolverConfig is the resolver configuration file used as the basis for the container DNS resolution configuration."), []
|
||||
runtimeCgroups <br /> *string* | Cgroups that container runtime is expected to be isolated in.
|
||||
runtimeRequestTimeout <br /> *[Duration](#duration-v1-meta)* | RuntimeRequestTimeout is timeout for runtime requests on - pull, logs, exec and attach
|
||||
seccompProfileRoot <br /> *string* | SeccompProfileRoot is the directory path for seccomp profiles.
|
||||
serializeImagePulls <br /> *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 <br /> *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 <br /> *object* | Capture resource reservation for OS system daemons like sshd, udev, etc.
|
||||
systemReservedCgroup <br /> *string* | Parent control group for OS system daemons.
|
||||
taints <br /> *string array* | Taints to add when registering a node in the cluster
|
||||
volumePluginDirectory <br /> *string* | The full path of the directory in which to search for additional third party volume plugins
|
||||
volumeStatsAggPeriod <br /> *[Duration](#duration-v1-meta)* | VolumeStatsAggPeriod is the interval for kubelet to calculate and cache the volume disk usage for all pods and volumes
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## KubenetNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KubenetNetworkingSpec
|
||||
|
||||
|
||||
|
||||
KubenetNetworkingSpec is the specification for kubenet networking, largely integrated but intended to replace classic
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
## KubeProxyConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KubeProxyConfig
|
||||
|
||||
|
||||
|
||||
KubeProxyConfig defines the configuration for a proxy
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
clusterCIDR <br /> *string* | ClusterCIDR is the CIDR range of the pods in the cluster
|
||||
cpuLimit <br /> *string* | CPULimit, cpu limit compute resource for kube proxy e.g. "30m"
|
||||
cpuRequest <br /> *string* | CPURequest, cpu request compute resource for kube proxy e.g. "20m"
|
||||
enabled <br /> *boolean* | Enabled allows enabling or disabling kube-proxy
|
||||
featureGates <br /> *object* | FeatureGates is a series of key pairs used to switch on features for the proxy
|
||||
hostnameOverride <br /> *string* | HostnameOverride, if non-empty, will be used as the identity instead of the actual hostname.
|
||||
image <br /> *string* |
|
||||
logLevel <br /> *integer* | LogLevel is the logging level of the proxy
|
||||
master <br /> *string* | Master is the address of the Kubernetes API server (overrides any value in kubeconfig)
|
||||
memoryLimit <br /> *string* | MemoryLimit, memory limit compute resource for kube proxy e.g. "30Mi"
|
||||
memoryRequest <br /> *string* | MemoryRequest, memory request compute resource for kube proxy e.g. "30Mi"
|
||||
proxyMode <br /> *string* | Which proxy mode to use: (userspace, iptables, ipvs)
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## KuberouterNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KuberouterNetworkingSpec
|
||||
|
||||
|
||||
|
||||
KuberouterNetworkingSpec declares that we want Kube-router networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## KubeSchedulerConfig v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | KubeSchedulerConfig
|
||||
|
||||
|
||||
|
||||
KubeSchedulerConfig is the configuration for the kube-scheduler
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
featureGates <br /> *object* | FeatureGates is set of key=value pairs that describe feature gates for alpha/experimental features.
|
||||
image <br /> *string* | Image is the docker image to use
|
||||
leaderElection <br /> *[LeaderElectionConfiguration](#leaderelectionconfiguration-v1alpha2-kops)* | LeaderElection defines the configuration of leader election client.
|
||||
logLevel <br /> *integer* | LogLevel is the logging level
|
||||
master <br /> *string* | Master is a url to the kube master
|
||||
usePolicyConfigMap <br /> *boolean* | UsePolicyConfigMap enable setting the scheduler policy from a configmap
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#cloudcontrollermanagerconfig-v1alpha2-kops">CloudControllerManagerConfig kops/v1alpha2</a></li>
|
||||
<li><a href="#kubecontrollermanagerconfig-v1alpha2-kops">KubeControllerManagerConfig kops/v1alpha2</a></li>
|
||||
<li><a href="#kubeschedulerconfig-v1alpha2-kops">KubeSchedulerConfig kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
leaderElect <br /> *boolean* | leaderElect enables a leader election client to gain leadership before executing the main loop. Enable this when running replicated components for high availability.
|
||||
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
## 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}.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterlist-v1alpha2-kops">ClusterList kops/v1alpha2</a></li>
|
||||
<li><a href="#instancegrouplist-v1alpha2-kops">InstanceGroupList kops/v1alpha2</a></li>
|
||||
<li><a href="#status-v1-meta">Status meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
continue <br /> *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 <br /> *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 <br /> *string* | selfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
## LoadBalancerAccessSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | LoadBalancerAccessSpec
|
||||
|
||||
|
||||
|
||||
LoadBalancerAccessSpec provides configuration details related to API LoadBalancer and its access
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#accessspec-v1alpha2-kops">AccessSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
additionalSecurityGroups <br /> *string array* |
|
||||
idleTimeoutSeconds <br /> *integer* |
|
||||
type <br /> *string* |
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
## NetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | NetworkingSpec
|
||||
|
||||
|
||||
|
||||
NetworkingSpec allows selection and configuration of a networking plugin
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
amazonvpc <br /> *[AmazonVPCNetworkingSpec](#amazonvpcnetworkingspec-v1alpha2-kops)* |
|
||||
calico <br /> *[CalicoNetworkingSpec](#caliconetworkingspec-v1alpha2-kops)* |
|
||||
canal <br /> *[CanalNetworkingSpec](#canalnetworkingspec-v1alpha2-kops)* |
|
||||
cilium <br /> *[CiliumNetworkingSpec](#ciliumnetworkingspec-v1alpha2-kops)* |
|
||||
classic <br /> *[ClassicNetworkingSpec](#classicnetworkingspec-v1alpha2-kops)* |
|
||||
cni <br /> *[CNINetworkingSpec](#cninetworkingspec-v1alpha2-kops)* |
|
||||
external <br /> *[ExternalNetworkingSpec](#externalnetworkingspec-v1alpha2-kops)* |
|
||||
flannel <br /> *[FlannelNetworkingSpec](#flannelnetworkingspec-v1alpha2-kops)* |
|
||||
kopeio <br /> *[KopeioNetworkingSpec](#kopeionetworkingspec-v1alpha2-kops)* |
|
||||
kubenet <br /> *[KubenetNetworkingSpec](#kubenetnetworkingspec-v1alpha2-kops)* |
|
||||
kuberouter <br /> *[KuberouterNetworkingSpec](#kuberouternetworkingspec-v1alpha2-kops)* |
|
||||
romana <br /> *[RomanaNetworkingSpec](#romananetworkingspec-v1alpha2-kops)* |
|
||||
weave <br /> *[WeaveNetworkingSpec](#weavenetworkingspec-v1alpha2-kops)* |
|
||||
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#cluster-v1alpha2-kops">Cluster kops/v1alpha2</a></li>
|
||||
<li><a href="#instancegroup-v1alpha2-kops">InstanceGroup kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
annotations <br /> *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 <br /> *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 <br /> *[Time](#time-v1-meta)* | 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 <br /> *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 <br /> *[Time](#time-v1-meta)* | 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 <br /> *string array* <br /> **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 <br /> *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 <br /> *integer* | A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
|
||||
initializers <br /> *[Initializers](#initializers-v1-meta)* | 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 <br /> *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 <br /> *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 <br /> *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 <br /> *[OwnerReference](#ownerreference-v1-meta) array* <br /> **patch type**: *merge* <br /> **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 <br /> *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 <br /> *string* | SelfLink is a URL representing this object. Populated by the system. Read-only.
|
||||
uid <br /> *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
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#objectmeta-v1-meta">ObjectMeta meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | API version of the referent.
|
||||
blockOwnerDeletion <br /> *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 <br /> *boolean* | If true, this reference points to the managing controller.
|
||||
kind <br /> *string* | Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
|
||||
name <br /> *string* | Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
uid <br /> *string* | UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
|
||||
|
||||
|
|
@ -0,0 +1,15 @@
|
|||
## 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
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## Preconditions v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | Preconditions
|
||||
|
||||
|
||||
|
||||
Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#deleteoptions-v1-meta">DeleteOptions meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
uid <br /> *string* | Specifies the target UID.
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## RBACAuthorizationSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | RBACAuthorizationSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#authorizationspec-v1alpha2-kops">AuthorizationSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## RomanaNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | RomanaNetworkingSpec
|
||||
|
||||
|
||||
|
||||
RomanaNetworkingSpec declares that we want Romana networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
daemonServiceIP <br /> *string* | DaemonServiceIP is the Kubernetes Service IP for the romana-daemon pod
|
||||
etcdServiceIP <br /> *string* | EtcdServiceIP is the Kubernetes Service IP for the etcd backend used by Romana
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#apigroup-v1-meta">APIGroup meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
clientCIDR <br /> *string* | The CIDR with which clients can match their IP to figure out the server address that they should use.
|
||||
serverAddress <br /> *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.
|
||||
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
## Status v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | Status
|
||||
|
||||
|
||||
|
||||
Status is a return value for calls that don't return other objects.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#initializers-v1-meta">Initializers meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *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 <br /> *integer* | Suggested HTTP return code for this status, 0 if not set.
|
||||
details <br /> *[StatusDetails](#statusdetails-v1-meta)* | 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 <br /> *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 <br /> *string* | A human-readable description of the status of this operation.
|
||||
metadata <br /> *[ListMeta](#listmeta-v1-meta)* | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
|
||||
reason <br /> *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 <br /> *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
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#statusdetails-v1-meta">StatusDetails meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
field <br /> *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 <br /> *string* | A human-readable description of the cause of the error. This field may be presented as-is to a reader.
|
||||
reason <br /> *string* | A machine-readable description of the cause of the error. If this value is empty there is no information available.
|
||||
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
## 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.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#status-v1-meta">Status meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
causes <br /> *[StatusCause](#statuscause-v1-meta) array* | The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
|
||||
group <br /> *string* | The group attribute of the resource associated with the status StatusReason.
|
||||
kind <br /> *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 <br /> *string* | The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
|
||||
retryAfterSeconds <br /> *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 <br /> *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
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## TargetSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | TargetSpec
|
||||
|
||||
|
||||
|
||||
TargetSpec allows for specifying target config in an extensible way
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
terraform <br /> *[TerraformSpec](#terraformspec-v1alpha2-kops)* |
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## TerraformSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | TerraformSpec
|
||||
|
||||
|
||||
|
||||
TerraformSpec allows us to specify terraform config in an extensible way
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#targetspec-v1alpha2-kops">TargetSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
providerExtraConfig <br /> *object* | ProviderExtraConfig contains key/value pairs to add to the rendered terraform "provider" block
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## Time v1 meta
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
meta | v1 | Time
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#objectmeta-v1-meta">ObjectMeta meta/v1</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
## TopologySpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | TopologySpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#clusterspec-v1alpha2-kops">ClusterSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
bastion <br /> *[BastionSpec](#bastionspec-v1alpha2-kops)* | 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 <br /> *[DNSSpec](#dnsspec-v1alpha2-kops)* | DNS configures options relating to DNS, in particular whether we use a public or a private hosted zone
|
||||
masters <br /> *string* | The environment to launch the Kubernetes masters in public|private
|
||||
nodes <br /> *string* | The environment to launch the Kubernetes nodes in public|private
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
## UserData v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | UserData
|
||||
|
||||
|
||||
|
||||
UserData defines a user-data section
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#instancegroupspec-v1alpha2-kops">InstanceGroupSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
content <br /> *string* | Content is the user-data content
|
||||
name <br /> *string* | Name is the name of the user-data
|
||||
type <br /> *string* | Type is the type of user-data
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## 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 <br /> *string* |
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## WeaveNetworkingSpec v1alpha2 kops
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
kops | v1alpha2 | WeaveNetworkingSpec
|
||||
|
||||
|
||||
|
||||
WeaveNetworkingSpec declares that we want Weave networking
|
||||
|
||||
<aside class="notice">
|
||||
Appears In:
|
||||
|
||||
<ul>
|
||||
<li><a href="#networkingspec-v1alpha2-kops">NetworkingSpec kops/v1alpha2</a></li>
|
||||
</ul></aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
connLimit <br /> *integer* |
|
||||
mtu <br /> *integer* |
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
|
||||
# <strong>kops</strong>
|
||||
|
||||
------------
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
|
||||
# <strong>Old Versions</strong>
|
||||
|
||||
------------
|
||||
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
|
||||
# <strong>Overview</strong>
|
||||
|
||||
------------
|
||||
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -22,6 +22,9 @@
|
|||
{
|
||||
"filename": "_generated_accessspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
{
|
||||
"filename": "_generated_addonspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
{
|
||||
"filename": "_generated_alwaysallowauthorizationspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
|
|
@ -49,6 +52,9 @@
|
|||
{
|
||||
"filename": "_generated_canalnetworkingspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
{
|
||||
"filename": "_generated_ciliumnetworkingspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
{
|
||||
"filename": "_generated_classicnetworkingspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
|
|
@ -79,6 +85,9 @@
|
|||
{
|
||||
"filename": "_generated_egressproxyspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
{
|
||||
"filename": "_generated_etcdbackupspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
{
|
||||
"filename": "_generated_etcdclusterspec_v1alpha2_kops_definition.md"
|
||||
},
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -7,7 +7,6 @@ kops is Kubernetes ops.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
kops is Kubernetes ops.
|
||||
|
||||
kops is the easiest way to get a production grade Kubernetes cluster up and running. We like to think of it as kubectl for clusters.
|
||||
|
|
@ -19,6 +18,7 @@ kops helps you create, destroy, upgrade and maintain production-grade, highly av
|
|||
```
|
||||
--alsologtostderr log to standard error as well as files
|
||||
--config string config file (default is $HOME/.kops.yaml)
|
||||
-h, --help help for kops
|
||||
--log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0)
|
||||
--log_dir string If non-empty, write log files in this directory
|
||||
--logtostderr log to standard error instead of files (default false)
|
||||
|
|
@ -30,6 +30,7 @@ kops helps you create, destroy, upgrade and maintain production-grade, highly av
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops completion](kops_completion.md) - Output shell completion code for the given shell (bash or zsh).
|
||||
* [kops create](kops_create.md) - Create a resource by command line, filename or stdin.
|
||||
* [kops delete](kops_delete.md) - Delete clusters,instancegroups, or secrets.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Output shell completion code for the given shell (bash or zsh).
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kops commands. This can be done by sourcing it from the .bash _profile.
|
||||
|
||||
Note: this requires the bash-completion framework, which is not installed by default on Mac. Once installed, bash completion must be evaluated. This can be done by adding the following line to the .bash profile
|
||||
|
|
@ -15,7 +14,7 @@ Note: this requires the bash-completion framework, which is not installed by def
|
|||
Note for zsh users: zsh completions are only supported in versions of zsh >= 5.2
|
||||
|
||||
```
|
||||
kops completion
|
||||
kops completion [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -43,6 +42,7 @@ kops completion
|
|||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for completion
|
||||
--shell string target shell (bash).
|
||||
```
|
||||
|
||||
|
|
@ -62,5 +62,6 @@ kops completion
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops](kops.md) - kops is Kubernetes ops.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Create a resource by command line, filename or stdin.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create a resource:
|
||||
|
||||
* cluster
|
||||
|
|
@ -17,7 +16,7 @@ Create a resource:
|
|||
Create a cluster, instancegroup or secret using command line parameters or YAML configuration specification files. (Note: secrets cannot be created from YAML config files yet).
|
||||
|
||||
```
|
||||
kops create -f FILENAME
|
||||
kops create -f FILENAME [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -47,7 +46,8 @@ kops create -f FILENAME
|
|||
### Options
|
||||
|
||||
```
|
||||
-f, --filename stringSlice Filename to use to create the resource
|
||||
-f, --filename strings Filename to use to create the resource
|
||||
-h, --help help for create
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
@ -66,6 +66,7 @@ kops create -f FILENAME
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops](kops.md) - kops is Kubernetes ops.
|
||||
* [kops create cluster](kops_create_cluster.md) - Create a Kubernetes cluster.
|
||||
* [kops create instancegroup](kops_create_instancegroup.md) - Create an instancegroup.
|
||||
|
|
|
|||
|
|
@ -7,13 +7,12 @@ Create a Kubernetes cluster.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create a kubernetes cluster using command line flags. This command creates cloud based resources such as networks and virtual machines. Once the infrastructure is in place Kubernetes is installed on the virtual machines.
|
||||
|
||||
These operations are done in parallel and rely on eventual consistency.
|
||||
|
||||
```
|
||||
kops create cluster
|
||||
kops create cluster [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -65,47 +64,48 @@ kops create cluster
|
|||
### Options
|
||||
|
||||
```
|
||||
--admin-access stringSlice Restrict API access to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
|
||||
--api-loadbalancer-type string Sets the API loadbalancer type to either 'public' or 'internal'
|
||||
--associate-public-ip Specify --associate-public-ip=[true|false] to enable/disable association of public IP for master ASG and nodes. Default is 'true'.
|
||||
--authorization string Authorization mode to use: AlwaysAllow or RBAC (default "RBAC")
|
||||
--bastion Pass the --bastion flag to enable a bastion instance group. Only applies to private topology.
|
||||
--channel string Channel for default versions and configuration to use (default "stable")
|
||||
--cloud string Cloud provider to use - gce, aws, vsphere
|
||||
--cloud-labels string A list of KV pairs used to tag all instance groups in AWS (eg "Owner=John Doe,Team=Some Team").
|
||||
--dns string DNS hosted zone to use: public|private. Default is 'public'. (default "Public")
|
||||
--dns-zone string DNS hosted zone to use (defaults to longest matching zone)
|
||||
--dry-run If true, only print the object that would be sent, without sending it. This flag can be used to create a cluster YAML or JSON manifest.
|
||||
--encrypt-etcd-storage Generate key in aws kms and use it for encrypt etcd volumes
|
||||
--image string Image to use for all instances.
|
||||
--kubernetes-version string Version of kubernetes to run (defaults to version in channel)
|
||||
--master-count int32 Set the number of masters. Defaults to one master per master-zone
|
||||
--master-public-name string Sets the public master public name
|
||||
--master-security-groups stringSlice Add precreated additional security groups to masters.
|
||||
--master-size string Set instance size for masters
|
||||
--master-tenancy string The tenancy of the master group on AWS. Can either be default or dedicated.
|
||||
--master-volume-size int32 Set instance volume size (in GB) for masters
|
||||
--master-zones stringSlice Zones in which to run masters (must be an odd number)
|
||||
--model string Models to apply (separate multiple models with commas) (default "config,proto,cloudup")
|
||||
--network-cidr string Set to override the default network CIDR
|
||||
--networking string Networking mode to use. kubenet (default), classic, external, kopeio-vxlan (or kopeio), weave, flannel-vxlan (or flannel), flannel-udp, calico, canal, kube-router, romana, amazon-vpc-routed-eni, cilium. (default "kubenet")
|
||||
--node-count int32 Set the number of nodes
|
||||
--node-security-groups stringSlice Add precreated additional security groups to nodes.
|
||||
--node-size string Set instance size for nodes
|
||||
--node-tenancy string The tenancy of the node group on AWS. Can be either default or dedicated.
|
||||
--node-volume-size int32 Set instance volume size (in GB) for nodes
|
||||
--out string Path to write any local output
|
||||
-o, --output string Output format. One of json|yaml. Used with the --dry-run flag.
|
||||
--project string Project to use (must be set on GCE)
|
||||
--ssh-access stringSlice Restrict SSH access to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
|
||||
--ssh-public-key string SSH public key to use (default "~/.ssh/id_rsa.pub")
|
||||
--subnets stringSlice Set to use shared subnets
|
||||
--target string Valid targets: direct, terraform, cloudformation. Set this flag to terraform if you want kops to generate terraform (default "direct")
|
||||
-t, --topology string Controls network topology for the cluster. public|private. Default is 'public'. (default "public")
|
||||
--utility-subnets stringSlice Set to use shared utility subnets
|
||||
--vpc string Set to use a shared VPC
|
||||
-y, --yes Specify --yes to immediately create the cluster
|
||||
--zones stringSlice Zones in which to run the cluster
|
||||
--admin-access strings Restrict API access to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
|
||||
--api-loadbalancer-type string Sets the API loadbalancer type to either 'public' or 'internal'
|
||||
--associate-public-ip Specify --associate-public-ip=[true|false] to enable/disable association of public IP for master ASG and nodes. Default is 'true'.
|
||||
--authorization string Authorization mode to use: AlwaysAllow or RBAC (default "RBAC")
|
||||
--bastion Pass the --bastion flag to enable a bastion instance group. Only applies to private topology.
|
||||
--channel string Channel for default versions and configuration to use (default "stable")
|
||||
--cloud string Cloud provider to use - gce, aws, vsphere
|
||||
--cloud-labels string A list of KV pairs used to tag all instance groups in AWS (eg "Owner=John Doe,Team=Some Team").
|
||||
--dns string DNS hosted zone to use: public|private. Default is 'public'. (default "Public")
|
||||
--dns-zone string DNS hosted zone to use (defaults to longest matching zone)
|
||||
--dry-run If true, only print the object that would be sent, without sending it. This flag can be used to create a cluster YAML or JSON manifest.
|
||||
--encrypt-etcd-storage Generate key in aws kms and use it for encrypt etcd volumes
|
||||
-h, --help help for cluster
|
||||
--image string Image to use for all instances.
|
||||
--kubernetes-version string Version of kubernetes to run (defaults to version in channel)
|
||||
--master-count int32 Set the number of masters. Defaults to one master per master-zone
|
||||
--master-public-name string Sets the public master public name
|
||||
--master-security-groups strings Add precreated additional security groups to masters.
|
||||
--master-size string Set instance size for masters
|
||||
--master-tenancy string The tenancy of the master group on AWS. Can either be default or dedicated.
|
||||
--master-volume-size int32 Set instance volume size (in GB) for masters
|
||||
--master-zones strings Zones in which to run masters (must be an odd number)
|
||||
--model string Models to apply (separate multiple models with commas) (default "config,proto,cloudup")
|
||||
--network-cidr string Set to override the default network CIDR
|
||||
--networking string Networking mode to use. kubenet (default), classic, external, kopeio-vxlan (or kopeio), weave, flannel-vxlan (or flannel), flannel-udp, calico, canal, kube-router, romana, amazon-vpc-routed-eni, cilium. (default "kubenet")
|
||||
--node-count int32 Set the number of nodes
|
||||
--node-security-groups strings Add precreated additional security groups to nodes.
|
||||
--node-size string Set instance size for nodes
|
||||
--node-tenancy string The tenancy of the node group on AWS. Can be either default or dedicated.
|
||||
--node-volume-size int32 Set instance volume size (in GB) for nodes
|
||||
--out string Path to write any local output
|
||||
-o, --output string Output format. One of json|yaml. Used with the --dry-run flag.
|
||||
--project string Project to use (must be set on GCE)
|
||||
--ssh-access strings Restrict SSH access to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
|
||||
--ssh-public-key string SSH public key to use (default "~/.ssh/id_rsa.pub")
|
||||
--subnets strings Set to use shared subnets
|
||||
--target string Valid targets: direct, terraform, cloudformation. Set this flag to terraform if you want kops to generate terraform (default "direct")
|
||||
-t, --topology string Controls network topology for the cluster. public|private. Default is 'public'. (default "public")
|
||||
--utility-subnets strings Set to use shared utility subnets
|
||||
--vpc string Set to use a shared VPC
|
||||
-y, --yes Specify --yes to immediately create the cluster
|
||||
--zones strings Zones in which to run the cluster
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
@ -124,5 +124,6 @@ kops create cluster
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create](kops_create.md) - Create a resource by command line, filename or stdin.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Create an instancegroup.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create an InstanceGroup configuration.
|
||||
|
||||
An InstanceGroup is a group of similar virtual machines. On AWS, an InstanceGroup maps to an AutoScalingGroup.
|
||||
|
|
@ -15,7 +14,7 @@ An InstanceGroup is a group of similar virtual machines. On AWS, an InstanceGrou
|
|||
The Role of an InstanceGroup defines whether machines will act as a Kubernetes master or node.
|
||||
|
||||
```
|
||||
kops create instancegroup
|
||||
kops create instancegroup [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -33,11 +32,12 @@ kops create instancegroup
|
|||
### Options
|
||||
|
||||
```
|
||||
--dry-run If true, only print the object that would be sent, without sending it. This flag can be used to create a cluster YAML or JSON manifest.
|
||||
--edit If true, an editor will be opened to edit default values. (default true)
|
||||
-o, --output string Output format. One of json|yaml
|
||||
--role string Type of instance group to create (Node,Master,Bastion) (default "Node")
|
||||
--subnet stringSlice Subnet in which to create instance group. One of Availability Zone like eu-west-1a or a comma-separated list of multiple Availability Zones.
|
||||
--dry-run If true, only print the object that would be sent, without sending it. This flag can be used to create a cluster YAML or JSON manifest.
|
||||
--edit If true, an editor will be opened to edit default values. (default true)
|
||||
-h, --help help for instancegroup
|
||||
-o, --output string Output format. One of json|yaml
|
||||
--role string Type of instance group to create (Node,Master,Bastion) (default "Node")
|
||||
--subnet strings Subnet in which to create instance group. One of Availability Zone like eu-west-1a or a comma-separated list of multiple Availability Zones.
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
@ -56,5 +56,6 @@ kops create instancegroup
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create](kops_create.md) - Create a resource by command line, filename or stdin.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Create a secret.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create a secret
|
||||
|
||||
### Examples
|
||||
|
|
@ -24,6 +23,12 @@ Create a secret
|
|||
--name k8s-cluster.example.com --state s3://example.com
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for secret
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -40,6 +45,7 @@ Create a secret
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create](kops_create.md) - Create a resource by command line, filename or stdin.
|
||||
* [kops create secret dockerconfig](kops_create_secret_dockerconfig.md) - Create a docker config.
|
||||
* [kops create secret encryptionconfig](kops_create_secret_encryptionconfig.md) - Create an encryption config.
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Create a docker config.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create a new docker config, and store it in the state store. Used to configure docker on each master or node (ie. for auth) Use update to modify it, this command will only create a new entry.
|
||||
|
||||
```
|
||||
kops create secret dockerconfig
|
||||
kops create secret dockerconfig [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -30,6 +29,7 @@ kops create secret dockerconfig
|
|||
```
|
||||
-f, -- string Path to docker config JSON file
|
||||
--force Force replace the kops secret if it already exists
|
||||
-h, --help help for dockerconfig
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
@ -48,5 +48,6 @@ kops create secret dockerconfig
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create secret](kops_create_secret.md) - Create a secret.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Create an encryption config.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create a new encryption config, and store it in the state store. Used to configure encryption-at-rest by the kube-apiserver process on each of the master nodes. The config is not updated by this command.
|
||||
|
||||
```
|
||||
kops create secret encryptionconfig
|
||||
kops create secret encryptionconfig [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -30,6 +29,7 @@ kops create secret encryptionconfig
|
|||
```
|
||||
-f, -- string Path to encryption config yaml file
|
||||
--force Force replace the kops secret if it already exists
|
||||
-h, --help help for encryptionconfig
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
@ -48,5 +48,6 @@ kops create secret encryptionconfig
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create secret](kops_create_secret.md) - Create a secret.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Create a secret keypair.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create a secret keypair
|
||||
|
||||
### Examples
|
||||
|
|
@ -19,6 +18,12 @@ Create a secret keypair
|
|||
--name k8s-cluster.example.com --state s3://example.com
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for keypair
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -35,6 +40,7 @@ Create a secret keypair
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create secret](kops_create_secret.md) - Create a secret.
|
||||
* [kops create secret keypair ca](kops_create_secret_keypair_ca.md) - Add a ca cert and key
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Add a ca cert and key
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Add a ca certificate and private key.
|
||||
|
||||
```
|
||||
kops create secret keypair ca
|
||||
kops create secret keypair ca [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -27,6 +26,7 @@ kops create secret keypair ca
|
|||
|
||||
```
|
||||
--cert string Path to ca cert
|
||||
-h, --help help for ca
|
||||
--key string Path to ca cert private key
|
||||
```
|
||||
|
||||
|
|
@ -46,5 +46,6 @@ kops create secret keypair ca
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create secret keypair](kops_create_secret_keypair.md) - Create a secret keypair.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Create a ssh public key.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Create a new ssh public key, and store the key in the state store. The key is not updated by this command.
|
||||
|
||||
```
|
||||
kops create secret sshpublickey
|
||||
kops create secret sshpublickey [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -25,6 +24,7 @@ kops create secret sshpublickey
|
|||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for sshpublickey
|
||||
-i, --pubkey string Path to SSH public key
|
||||
```
|
||||
|
||||
|
|
@ -44,5 +44,6 @@ kops create secret sshpublickey
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops create secret](kops_create_secret.md) - Create a secret.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Delete clusters,instancegroups, or secrets.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Delete Kubernetes clusters, instancegroups, and secrets, or a combination of the before mentioned.
|
||||
|
||||
```
|
||||
kops delete -f FILENAME [--yes]
|
||||
kops delete -f FILENAME [--yes] [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -31,8 +30,9 @@ kops delete -f FILENAME [--yes]
|
|||
### Options
|
||||
|
||||
```
|
||||
-f, --filename stringSlice Filename to use to delete the resource
|
||||
-y, --yes Specify --yes to delete the resource
|
||||
-f, --filename strings Filename to use to delete the resource
|
||||
-h, --help help for delete
|
||||
-y, --yes Specify --yes to delete the resource
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
@ -51,6 +51,7 @@ kops delete -f FILENAME [--yes]
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops](kops.md) - kops is Kubernetes ops.
|
||||
* [kops delete cluster](kops_delete_cluster.md) - Delete a cluster.
|
||||
* [kops delete instancegroup](kops_delete_instancegroup.md) - Delete instancegroup
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Delete a cluster.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Deletes a Kubernetes cluster and all associated resources. Resources include instancegroups, secrets and the state store. There is no "UNDO" for this command.
|
||||
|
||||
```
|
||||
kops delete cluster CLUSTERNAME [--yes]
|
||||
kops delete cluster CLUSTERNAME [--yes] [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -26,6 +25,7 @@ kops delete cluster CLUSTERNAME [--yes]
|
|||
|
||||
```
|
||||
--external Delete an external cluster
|
||||
-h, --help help for cluster
|
||||
--region string region
|
||||
--unregister Don't delete cloud resources, just unregister the cluster
|
||||
-y, --yes Specify --yes to delete the cluster
|
||||
|
|
@ -47,5 +47,6 @@ kops delete cluster CLUSTERNAME [--yes]
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops delete](kops_delete.md) - Delete clusters,instancegroups, or secrets.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Delete instancegroup
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Delete an instancegroup configuration. kops has the concept of "instance groups", which are a group of similar virtual machines. On AWS, they map to an AutoScalingGroup. An ig work either as a Kubernetes master or a node.
|
||||
|
||||
```
|
||||
kops delete instancegroup
|
||||
kops delete instancegroup [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -26,7 +25,8 @@ kops delete instancegroup
|
|||
### Options
|
||||
|
||||
```
|
||||
-y, --yes Specify --yes to immediately delete the instance group
|
||||
-h, --help help for instancegroup
|
||||
-y, --yes Specify --yes to immediately delete the instance group
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
|
@ -45,5 +45,6 @@ kops delete instancegroup
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops delete](kops_delete.md) - Delete clusters,instancegroups, or secrets.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Delete a secret
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Delete a secret.
|
||||
|
||||
```
|
||||
kops delete secret
|
||||
kops delete secret [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -20,6 +19,12 @@ kops delete secret
|
|||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for secret
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -36,5 +41,6 @@ kops delete secret
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops delete](kops_delete.md) - Delete clusters,instancegroups, or secrets.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Describe a resource.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Get additional information about cloud and cluster resources.
|
||||
|
||||
### Examples
|
||||
|
|
@ -16,6 +15,12 @@ Get additional information about cloud and cluster resources.
|
|||
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for describe
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -32,6 +37,7 @@ Get additional information about cloud and cluster resources.
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops](kops.md) - kops is Kubernetes ops.
|
||||
* [kops describe secrets](kops_describe_secrets.md) - Describe a cluster secret
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,10 @@ Describe a cluster secret
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Get additional information about cluster secrets.
|
||||
|
||||
```
|
||||
kops describe secrets
|
||||
kops describe secrets [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -23,6 +22,7 @@ kops describe secrets
|
|||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for secrets
|
||||
--type string Filter by secret type
|
||||
```
|
||||
|
||||
|
|
@ -42,5 +42,6 @@ kops describe secrets
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops describe](kops_describe.md) - Describe a resource.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Edit clusters and other resources.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Edit a resource configuration. This command changes the desired configuration in the registry.
|
||||
|
||||
To set your preferred editor, you can define the EDITOR environment variable.
|
||||
|
|
@ -26,6 +25,12 @@ Edit a resource configuration. This command changes the desired configuration in
|
|||
--state=s3://kops-state-1234 nodes
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for edit
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -42,6 +47,7 @@ Edit a resource configuration. This command changes the desired configuration in
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops](kops.md) - kops is Kubernetes ops.
|
||||
* [kops edit cluster](kops_edit_cluster.md) - Edit cluster.
|
||||
* [kops edit instancegroup](kops_edit_instancegroup.md) - Edit instancegroup.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Edit cluster.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Edit a cluster configuration.
|
||||
|
||||
This command changes the desired cluster configuration in the registry.
|
||||
|
|
@ -18,7 +17,7 @@ This command changes the desired cluster configuration in the registry.
|
|||
kops edit does not update the cloud resources, to apply the changes use "kops update cluster".
|
||||
|
||||
```
|
||||
kops edit cluster
|
||||
kops edit cluster [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -28,6 +27,12 @@ kops edit cluster
|
|||
kops edit cluster k8s.cluster.site --state=s3://kops-state-1234
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for cluster
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -44,5 +49,6 @@ kops edit cluster
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops edit](kops_edit.md) - Edit clusters and other resources.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Edit instancegroup.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Edit a cluster configuration.
|
||||
|
||||
This command changes the instancegroup desired configuration in the registry.
|
||||
|
|
@ -18,7 +17,7 @@ This command changes the instancegroup desired configuration in the registry.
|
|||
kops edit does not update the cloud resources, to apply the changes use "kops update cluster".
|
||||
|
||||
```
|
||||
kops edit instancegroup
|
||||
kops edit instancegroup [flags]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
|
@ -28,6 +27,12 @@ kops edit instancegroup
|
|||
kops edit ig --name k8s-cluster.example.com node --state=s3://kops-state-1234
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for instancegroup
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -44,5 +49,6 @@ kops edit instancegroup
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops edit](kops_edit.md) - Edit clusters and other resources.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,6 @@ Export configuration.
|
|||
|
||||
### Synopsis
|
||||
|
||||
|
||||
Export configurations from a cluster.
|
||||
|
||||
### Examples
|
||||
|
|
@ -17,6 +16,12 @@ Export configurations from a cluster.
|
|||
kops export kubecfg kubernetes-cluster.example.com
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
```
|
||||
-h, --help help for export
|
||||
```
|
||||
|
||||
### Options inherited from parent commands
|
||||
|
||||
```
|
||||
|
|
@ -33,6 +38,7 @@ Export configurations from a cluster.
|
|||
```
|
||||
|
||||
### SEE ALSO
|
||||
|
||||
* [kops](kops.md) - kops is Kubernetes ops.
|
||||
* [kops export kubecfg](kops_export_kubecfg.md) - Export kubecfg.
|
||||
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue