kubernetes
/
kops
mirror of https://github.com/kubernetes/kops.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Copyedit the InstanceGroup-related documentation

This commit is contained in:
Steven E. Harris 2021-02-23 15:45:54 -05:00
parent e39c985ee7
commit 70e95fccf5
3 changed files with 32 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
k8s/crds/kops.k8s.io_instancegroups.yaml
View File

@ -58,7 +58,7 @@ spec:
metadata: metadata:
type: object type: object
spec: spec:
description: InstanceGroupSpec is the specification for an instanceGroup description: InstanceGroupSpec is the specification for an InstanceGroup
properties: properties:
additionalSecurityGroups: additionalSecurityGroups:
description: AdditionalSecurityGroups attaches additional security description: AdditionalSecurityGroups attaches additional security
@ -89,7 +89,7 @@ spec:
type: boolean type: boolean
autoscale: autoscale:
description: Autoscale determines if autoscaling will be enabled for description: Autoscale determines if autoscaling will be enabled for
the group if cluster autoscaler is enabled this instance group if cluster autoscaler is enabled
type: boolean type: boolean
cloudLabels: cloudLabels:
additionalProperties: additionalProperties:
@ -111,7 +111,7 @@ spec:
type: boolean type: boolean
externalLoadBalancers: externalLoadBalancers:
description: ExternalLoadBalancers define loadbalancers that should description: ExternalLoadBalancers define loadbalancers that should
be attached to the instancegroup be attached to this instance group
items: items:
description: LoadBalancer defines a load balancer description: LoadBalancer defines a load balancer
properties: properties:
@ -706,11 +706,11 @@ spec:
additionalProperties: additionalProperties:
type: string type: string
description: NodeLabels indicates the kubernetes labels for nodes description: NodeLabels indicates the kubernetes labels for nodes
in this group in this instance group
type: object type: object
role: role:
description: 'Type determines the role of instances in this group: description: 'Type determines the role of instances in this instance
masters or nodes' group: masters or nodes'
type: string type: string
rollingUpdate: rollingUpdate:
description: RollingUpdate defines the rolling-update behavior description: RollingUpdate defines the rolling-update behavior
@ -817,20 +817,21 @@ spec:
type: array type: array
taints: taints:
description: Taints indicates the kubernetes taints for nodes in this description: Taints indicates the kubernetes taints for nodes in this
group instance group
items: items:
type: string type: string
type: array type: array
tenancy: tenancy:
description: Describes the tenancy of the instance group. Can be either description: Describes the tenancy of this instance group. Can be
default or dedicated. Currently only applies to AWS. either default or dedicated. Currently only applies to AWS.
type: string type: string
updatePolicy: updatePolicy:
description: 'UpdatePolicy determines the policy for applying upgrades description: 'UpdatePolicy determines the policy for applying upgrades
automatically. Valid values: ''automatic'' (default): apply updates automatically. If specified, this value overrides a value specified
automatically (apply OS security upgrades, avoiding rebooting when in the Cluster''s "spec.updatePolicy" field. Valid values: ''automatic''
possible) ''external'': do not apply updates automatically; they (default): apply updates automatically (apply OS security upgrades,
are applied manually or by an external system' avoiding rebooting when possible) ''external'': do not apply updates
automatically; they are applied manually or by an external system'
type: string type: string
volumeMounts: volumeMounts:
description: VolumeMounts a collection of volume mounts description: VolumeMounts a collection of volume mounts

19
pkg/apis/kops/instancegroup.go
View File

@ -82,9 +82,9 @@ var (
SupportedFilesystems = []string{BtfsFilesystem, Ext4Filesystem, XFSFilesystem} SupportedFilesystems = []string{BtfsFilesystem, Ext4Filesystem, XFSFilesystem}
) )
// InstanceGroupSpec is the specification for a instanceGroup // InstanceGroupSpec is the specification for an InstanceGroup
type InstanceGroupSpec struct { type InstanceGroupSpec struct {
// Type determines the role of instances in this group: masters or nodes // Type determines the role of instances in this instance group: masters or nodes
Role InstanceGroupRole `json:"role,omitempty"` Role InstanceGroupRole `json:"role,omitempty"`
// Image is the instance (ami etc) we should use // Image is the instance (ami etc) we should use
Image string `json:"image,omitempty"` Image string `json:"image,omitempty"`
@ -92,7 +92,7 @@ type InstanceGroupSpec struct {
MinSize *int32 `json:"minSize,omitempty"` MinSize *int32 `json:"minSize,omitempty"`
// MaxSize is the maximum size of the pool // MaxSize is the maximum size of the pool
MaxSize *int32 `json:"maxSize,omitempty"` MaxSize *int32 `json:"maxSize,omitempty"`
// Autoscale determines if autoscaling will be enabled for the group if cluster autoscaler is enabled // Autoscale determines if autoscaling will be enabled for this instance group if cluster autoscaler is enabled
Autoscale *bool `json:"autoscale,omitempty"` Autoscale *bool `json:"autoscale,omitempty"`
// MachineType is the instance class // MachineType is the instance class
MachineType string `json:"machineType,omitempty"` MachineType string `json:"machineType,omitempty"`
@ -114,7 +114,7 @@ type InstanceGroupSpec struct {
RootVolumeEncryption *bool `json:"rootVolumeEncryption,omitempty"` RootVolumeEncryption *bool `json:"rootVolumeEncryption,omitempty"`
// RootVolumeEncryptionKey provides the key identifier for root volume encryption // RootVolumeEncryptionKey provides the key identifier for root volume encryption
RootVolumeEncryptionKey *string `json:"rootVolumeEncryptionKey,omitempty"` RootVolumeEncryptionKey *string `json:"rootVolumeEncryptionKey,omitempty"`
// Volumes is a collection of additional volumes to create for instances within this InstanceGroup // Volumes is a collection of additional volumes to create for instances within this instance group
Volumes []VolumeSpec `json:"volumes,omitempty"` Volumes []VolumeSpec `json:"volumes,omitempty"`
// VolumeMounts a collection of volume mounts // VolumeMounts a collection of volume mounts
VolumeMounts []VolumeMountSpec `json:"volumeMounts,omitempty"` VolumeMounts []VolumeMountSpec `json:"volumeMounts,omitempty"`
@ -123,7 +123,7 @@ type InstanceGroupSpec struct {
// Zones is the names of the Zones where machines in this instance group should be placed // 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 // This is needed for regional subnets (e.g. GCE), to restrict placement to particular zones
Zones []string `json:"zones,omitempty"` Zones []string `json:"zones,omitempty"`
// Hooks is a list of hooks for this instanceGroup, note: these can override the cluster wide ones if required // Hooks is a list of hooks for this instance group, note: these can override the cluster wide ones if required
Hooks []HookSpec `json:"hooks,omitempty"` Hooks []HookSpec `json:"hooks,omitempty"`
// MaxPrice indicates this is a spot-pricing group, with the specified value as our max-price bid // MaxPrice indicates this is a spot-pricing group, with the specified value as our max-price bid
MaxPrice *string `json:"maxPrice,omitempty"` MaxPrice *string `json:"maxPrice,omitempty"`
@ -137,15 +137,15 @@ type InstanceGroupSpec struct {
AdditionalSecurityGroups []string `json:"additionalSecurityGroups,omitempty"` AdditionalSecurityGroups []string `json:"additionalSecurityGroups,omitempty"`
// CloudLabels defines additional tags or labels on cloud provider resources // CloudLabels defines additional tags or labels on cloud provider resources
CloudLabels map[string]string `json:"cloudLabels,omitempty"` CloudLabels map[string]string `json:"cloudLabels,omitempty"`
// NodeLabels indicates the kubernetes labels for nodes in this group // NodeLabels indicates the kubernetes labels for nodes in this instance group
NodeLabels map[string]string `json:"nodeLabels,omitempty"` NodeLabels map[string]string `json:"nodeLabels,omitempty"`
// FileAssets is a collection of file assets for this instance group // FileAssets is a collection of file assets for this instance group
FileAssets []FileAssetSpec `json:"fileAssets,omitempty"` FileAssets []FileAssetSpec `json:"fileAssets,omitempty"`
// Describes the tenancy of the instance group. Can be either default or dedicated. Currently only applies to AWS. // Describes the tenancy of this instance group. Can be either default or dedicated. Currently only applies to AWS.
Tenancy string `json:"tenancy,omitempty"` Tenancy string `json:"tenancy,omitempty"`
// Kubelet overrides kubelet config from the ClusterSpec // Kubelet overrides kubelet config from the ClusterSpec
Kubelet *KubeletConfigSpec `json:"kubelet,omitempty"` Kubelet *KubeletConfigSpec `json:"kubelet,omitempty"`
// Taints indicates the kubernetes taints for nodes in this group // Taints indicates the kubernetes taints for nodes in this instance group
Taints []string `json:"taints,omitempty"` Taints []string `json:"taints,omitempty"`
// MixedInstancesPolicy defined a optional backing of an AWS ASG by a EC2 Fleet (AWS Only) // MixedInstancesPolicy defined a optional backing of an AWS ASG by a EC2 Fleet (AWS Only)
MixedInstancesPolicy *MixedInstancesPolicySpec `json:"mixedInstancesPolicy,omitempty"` MixedInstancesPolicy *MixedInstancesPolicySpec `json:"mixedInstancesPolicy,omitempty"`
@ -153,7 +153,7 @@ type InstanceGroupSpec struct {
AdditionalUserData []UserData `json:"additionalUserData,omitempty"` AdditionalUserData []UserData `json:"additionalUserData,omitempty"`
// SuspendProcesses disables the listed Scaling Policies // SuspendProcesses disables the listed Scaling Policies
SuspendProcesses []string `json:"suspendProcesses,omitempty"` SuspendProcesses []string `json:"suspendProcesses,omitempty"`
// ExternalLoadBalancers define loadbalancers that should be attached to the instancegroup // ExternalLoadBalancers define loadbalancers that should be attached to this instance group
ExternalLoadBalancers []LoadBalancer `json:"externalLoadBalancers,omitempty"` ExternalLoadBalancers []LoadBalancer `json:"externalLoadBalancers,omitempty"`
// DetailedInstanceMonitoring defines if detailed-monitoring is enabled (AWS only) // DetailedInstanceMonitoring defines if detailed-monitoring is enabled (AWS only)
DetailedInstanceMonitoring *bool `json:"detailedInstanceMonitoring,omitempty"` DetailedInstanceMonitoring *bool `json:"detailedInstanceMonitoring,omitempty"`
@ -177,6 +177,7 @@ type InstanceGroupSpec struct {
// InstanceMetadata defines the EC2 instance metadata service options (AWS Only) // InstanceMetadata defines the EC2 instance metadata service options (AWS Only)
InstanceMetadata *InstanceMetadataOptions `json:"instanceMetadata,omitempty"` InstanceMetadata *InstanceMetadataOptions `json:"instanceMetadata,omitempty"`
// UpdatePolicy determines the policy for applying upgrades automatically. // UpdatePolicy determines the policy for applying upgrades automatically.
// If specified, this value overrides a value specified in the Cluster's "spec.updatePolicy" field.
// Valid values: // Valid values:
// 'automatic' (default): apply updates automatically (apply OS security upgrades, avoiding rebooting when possible) // 'automatic' (default): apply updates automatically (apply OS security upgrades, avoiding rebooting when possible)
// 'external': do not apply updates automatically; they are applied manually or by an external system // 'external': do not apply updates automatically; they are applied manually or by an external system

15
pkg/apis/kops/v1alpha2/instancegroup.go
View File

@ -79,9 +79,9 @@ var (
SupportedFilesystems = []string{BtfsFilesystem, Ext4Filesystem, XFSFilesystem} SupportedFilesystems = []string{BtfsFilesystem, Ext4Filesystem, XFSFilesystem}
) )
// InstanceGroupSpec is the specification for an instanceGroup // InstanceGroupSpec is the specification for an InstanceGroup
type InstanceGroupSpec struct { type InstanceGroupSpec struct {
// Type determines the role of instances in this group: masters or nodes // Type determines the role of instances in this instance group: masters or nodes
Role InstanceGroupRole `json:"role,omitempty"` Role InstanceGroupRole `json:"role,omitempty"`
// Image is the instance (ami etc) we should use // Image is the instance (ami etc) we should use
Image string `json:"image,omitempty"` Image string `json:"image,omitempty"`
@ -89,7 +89,7 @@ type InstanceGroupSpec struct {
MinSize *int32 `json:"minSize,omitempty"` MinSize *int32 `json:"minSize,omitempty"`
// MaxSize is the maximum size of the pool // MaxSize is the maximum size of the pool
MaxSize *int32 `json:"maxSize,omitempty"` MaxSize *int32 `json:"maxSize,omitempty"`
// Autoscale determines if autoscaling will be enabled for the group if cluster autoscaler is enabled // Autoscale determines if autoscaling will be enabled for this instance group if cluster autoscaler is enabled
Autoscale *bool `json:"autoscale,omitempty"` Autoscale *bool `json:"autoscale,omitempty"`
// MachineType is the instance class // MachineType is the instance class
MachineType string `json:"machineType,omitempty"` MachineType string `json:"machineType,omitempty"`
@ -134,16 +134,16 @@ type InstanceGroupSpec struct {
AdditionalSecurityGroups []string `json:"additionalSecurityGroups,omitempty"` AdditionalSecurityGroups []string `json:"additionalSecurityGroups,omitempty"`
// CloudLabels defines additional tags or labels on cloud provider resources // CloudLabels defines additional tags or labels on cloud provider resources
CloudLabels map[string]string `json:"cloudLabels,omitempty"` CloudLabels map[string]string `json:"cloudLabels,omitempty"`
// NodeLabels indicates the kubernetes labels for nodes in this group // NodeLabels indicates the kubernetes labels for nodes in this instance group
NodeLabels map[string]string `json:"nodeLabels,omitempty"` NodeLabels map[string]string `json:"nodeLabels,omitempty"`
// FileAssets is a collection of file assets for this instance group // FileAssets is a collection of file assets for this instance group
FileAssets []FileAssetSpec `json:"fileAssets,omitempty"` FileAssets []FileAssetSpec `json:"fileAssets,omitempty"`
// Describes the tenancy of the instance group. Can be either default or dedicated. // Describes the tenancy of this instance group. Can be either default or dedicated.
// Currently only applies to AWS. // Currently only applies to AWS.
Tenancy string `json:"tenancy,omitempty"` Tenancy string `json:"tenancy,omitempty"`
// Kubelet overrides kubelet config from the ClusterSpec // Kubelet overrides kubelet config from the ClusterSpec
Kubelet *KubeletConfigSpec `json:"kubelet,omitempty"` Kubelet *KubeletConfigSpec `json:"kubelet,omitempty"`
// Taints indicates the kubernetes taints for nodes in this group // Taints indicates the kubernetes taints for nodes in this instance group
Taints []string `json:"taints,omitempty"` Taints []string `json:"taints,omitempty"`
// MixedInstancesPolicy defined a optional backing of an AWS ASG by a EC2 Fleet (AWS Only) // MixedInstancesPolicy defined a optional backing of an AWS ASG by a EC2 Fleet (AWS Only)
MixedInstancesPolicy *MixedInstancesPolicySpec `json:"mixedInstancesPolicy,omitempty"` MixedInstancesPolicy *MixedInstancesPolicySpec `json:"mixedInstancesPolicy,omitempty"`
@ -151,7 +151,7 @@ type InstanceGroupSpec struct {
AdditionalUserData []UserData `json:"additionalUserData,omitempty"` AdditionalUserData []UserData `json:"additionalUserData,omitempty"`
// SuspendProcesses disables the listed Scaling Policies // SuspendProcesses disables the listed Scaling Policies
SuspendProcesses []string `json:"suspendProcesses,omitempty"` SuspendProcesses []string `json:"suspendProcesses,omitempty"`
// ExternalLoadBalancers define loadbalancers that should be attached to the instancegroup // ExternalLoadBalancers define loadbalancers that should be attached to this instance group
ExternalLoadBalancers []LoadBalancer `json:"externalLoadBalancers,omitempty"` ExternalLoadBalancers []LoadBalancer `json:"externalLoadBalancers,omitempty"`
// DetailedInstanceMonitoring defines if detailed-monitoring is enabled (AWS only) // DetailedInstanceMonitoring defines if detailed-monitoring is enabled (AWS only)
DetailedInstanceMonitoring *bool `json:"detailedInstanceMonitoring,omitempty"` DetailedInstanceMonitoring *bool `json:"detailedInstanceMonitoring,omitempty"`
@ -175,6 +175,7 @@ type InstanceGroupSpec struct {
// InstanceMetadata defines the EC2 instance metadata service options (AWS Only) // InstanceMetadata defines the EC2 instance metadata service options (AWS Only)
InstanceMetadata *InstanceMetadataOptions `json:"instanceMetadata,omitempty"` InstanceMetadata *InstanceMetadataOptions `json:"instanceMetadata,omitempty"`
// UpdatePolicy determines the policy for applying upgrades automatically. // UpdatePolicy determines the policy for applying upgrades automatically.
// If specified, this value overrides a value specified in the Cluster's "spec.updatePolicy" field.
// Valid values: // Valid values:
// 'automatic' (default): apply updates automatically (apply OS security upgrades, avoiding rebooting when possible) // 'automatic' (default): apply updates automatically (apply OS security upgrades, avoiding rebooting when possible)
// 'external': do not apply updates automatically; they are applied manually or by an external system // 'external': do not apply updates automatically; they are applied manually or by an external system