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

Merge pull request #7139 from granular-ryanbonham/6928_improve_cloud_label_docs 

Improve docs on labels
This commit is contained in:
Kubernetes Prow Robot 2019-06-20 10:34:49 -07:00 committed by GitHub
parent e76cd16f55 bda8288d1b
commit b18a06dacc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
docs/labels.md
View File

@ -2,15 +2,47 @@
There are two main types of labels that kops can create:
* `CloudLabels` become tags in AWS on the instances
* `NodeLabels` become labels on the k8s Node objects
* `cloudLabels` become tags in AWS on the instances
* `nodeLabels` become labels on the k8s Node objects
Both are specified at the InstanceGroup level.
## cloudLabels
cloudLabels can be specified at the cluster and instance group level.
Labels specified at the cluster level will be copied to Load Balancers and to Master EBS volumes. They will also be merged to instance groups cloudLabels, with labels specified at the instance group overriding the cluster level.
A nice use for cloudLabels is to specify [AWS cost allocation tags](http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html).
An example:
`kops edit ig nodes`
```
...
spec:
cloudLabels:
team: me
project: ion
...
```
`kops edit cluster`
```
...
spec:
cloudLabels:
team: me
project: ion
...
```
## nodeLabels
nodeLabels are specified at the instance group.
A good use for nodeLabels is to implement [nodeSelector labels](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#step-two-add-a-nodeselector-field-to-your-pod-configuration).
CloudLabels and nodeLabels are automatically applied to new nodes created by [AWS EC2 auto scaling groups](https://aws.amazon.com/autoscaling/).
cloudLabels and nodeLabels are automatically applied to new nodes created by [AWS EC2 auto scaling groups](https://aws.amazon.com/autoscaling/).
An example:
@ -21,19 +53,16 @@ An example:
spec:
nodeLabels:
spot: "false"
cloudLabels:
team: me
project: ion
...
```
Note that keys and values are strings, so you need quotes around values that YAML
would otherwise treat as numbers or booleans.
Note that keys and values are strings, so you need quotes around values that YAML would otherwise treat as numbers or booleans.
## Applying Label Updates
To apply changes, you'll need to do a `kops update cluster` and then likely a `kops rolling-update cluster`
For AWS if `kops rolling-update cluster --instance-group nodes` returns "No rolling-update required." the
[kops rolling-update cluster](https://github.com/kubernetes/kops/blob/8bc48ef10a44a3e481b604f5dbb663420c68dcab/docs/cli/kops_rolling-update_cluster.md) `--force` flag can be used to force a rolling update, even when no changes are identified.
For AWS if `kops rolling-update cluster --instance-group nodes` returns "No rolling-update required." the [kops rolling-update cluster](https://github.com/kubernetes/kops/blob/8bc48ef10a44a3e481b604f5dbb663420c68dcab/docs/cli/kops_rolling-update_cluster.md) `--force` flag can be used to force a rolling update, even when no changes are identified.
Example: