forked from kubernetes/kops
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Beginning of docs about commands and args
- Loading branch information
Showing
2 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Detailed description of arguments | ||
|
||
## dns-zone | ||
|
||
dns-zone controls the Route53 hosted zone in which DNS records will be created. It can either by the name | ||
of the hosted zone (`example.com`), or it can be the ID of the hosted zone (`Z1GABCD1ABC2DEF`) | ||
|
||
Suppose you're creating a cluster named "dev.kubernetes.example.com`: | ||
|
||
* You can specify a `--dns-zone=example.com` (you can have subdomains in a hosted zone) | ||
* You could also use `--dns-zone=kubernetes.example.com` | ||
|
||
You do have to set up the DNS nameservers so your hosted zone resolves. kops used to create the hosted | ||
zone for you, but now (as you have to set up the nameservers anyway), there doesn't seem much reason to do so! | ||
|
||
If you don't specify a dns-zone, kops will list all your hosted zones, and choose the longest that | ||
is a a suffix of your cluster name. So for `dev.kubernetes.example.com`, if you have `kubernetes.example.com`, | ||
`example.com` and `somethingelse.example.com`, it would choose `kubernetes.example.com`. `example.com` matches | ||
but is shorter; `somethingelse.example.com` is not a suffix-match. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
## `kops get clusters` | ||
|
||
`kops get clusters` lists all clusters in the registry. | ||
|
||
## `kops delete cluster` | ||
|
||
`kops delete cluster` deletes the cloud resources (instances, DNS entries, volumes, ELBs, VPCs etc) for a particular | ||
cluster. It also removes the cluster from the registry. | ||
|
||
It is recommended that you run it first in 'preview' mode with `kops delete cluster --name <name>`, and then | ||
when you are happy that it is deleting the right things you do `kops delete cluster --name <name> --yes`. | ||
|
||
|
||
## `kops version` | ||
|
||
`kops version` will print the version of the code you are running. |