Permalink
Browse files

Merge pull request #89 from sarahelizgray/update-kube-readme-region-d…

…efault-and-formatting

Update kube readme region default and formatting
  • Loading branch information...
Dorthu committed Dec 15, 2018
2 parents 376815f + 75b8beb commit 830170af54527a3a2e0fbb389e431977fdd4004b
Showing with 39 additions and 39 deletions.
  1. +39 −39 README.rst
@@ -102,8 +102,45 @@ View your user::

linode-cli profile view

Reconfiguring
"""""""""""""

If your token expires or you want to otherwise change your configuration, simply
run the *configure* command::

linode-cli configure

Suppressing Defaults
""""""""""""""""""""

If you configured default values for `image`, `region`, and Linode `type`, they
will be sent for all requests that accept them if you do not specify a different
value. If you want to send a request *without* these arguments, you must invoke
the CLI with the `--no-defaults` option. For example, to create a Linode with
no `image` after a default Image has been configured, you would do this::

linode-cli linodes create --region us-east --type g5-standard-2 --no-defaults

Suppressing Warnings
""""""""""""""""""""

In some situations, like when the CLI is out of date, it will generate a warning
in addition to its normal output. If these warnings can interfere with your
scripts or you otherwise want them disabled, simply add the `--suppress-warnings`
flag to prevent them from being emitted.

Environment Variables
"""""""""""""""""""""

If you prefer, you may store your token in an environment variable named
`LINODE_CLI TOKEN` instead of using the configuration file. Doing so allows you
to bypass the initial configuration, and subsequent calls to `linode-cli configure`
will allow you to set defaults without having to set a token. Be aware that if
the environment variable should be unset, the Linode CLI will stop working until
it is set again or the CLI is reconfigured with a token.

Kubernetes Deployment Plugin
""""""""""""""""""""""""""""
----------------------------

A plugin is included that allows you to deploy a Kubernetes cluster on Linode! These commands require Terraform, the Kubernetes CLI, and an SSH key added to your ssh-agent. If any dependencies are not present, you'll recieve installation instructions during command execution.

@@ -145,7 +182,7 @@ The following is the help message for the command::
"g6-standard-2")
--region REGION The Linode Region ID in which to deploy the cluster as
retrieved with `linode-cli regions list`. (default
"us-west")
is whatever you set during CLI configuration)
--ssh-public-key KEYPATH
The path to your public key file which will be used to
access Nodes during initial provisioning only! The
@@ -174,43 +211,6 @@ To delete a cluster simply run::

linode-cli k8s-alpha delete mycluster77

Reconfiguring
"""""""""""""

If your token expires or you want to otherwise change your configuration, simply
run the *configure* command::

linode-cli configure

Suppressing Defaults
""""""""""""""""""""

If you configured default values for `image`, `region`, and Linode `type`, they
will be sent for all requests that accept them if you do not specify a different
value. If you want to send a request *without* these arguments, you must invoke
the CLI with the `--no-defaults` option. For example, to create a Linode with
no `image` after a default Image has been configured, you would do this::

linode-cli linodes create --region us-east --type g5-standard-2 --no-defaults

Suppressing Warnings
""""""""""""""""""""

In some situations, like when the CLI is out of date, it will generate a warning
in addition to its normal output. If these warnings can interfere with your
scripts or you otherwise want them disabled, simply add the `--suppress-warnings`
flag to prevent them from being emitted.

Environment Variables
"""""""""""""""""""""

If you prefer, you may store your token in an environment variable named
`LINODE_CLI TOKEN` instead of using the configuration file. Doing so allows you
to bypass the initial configuration, and subsequent calls to `linode-cli configure`
will allow you to set defaults without having to set a token. Be aware that if
the environment variable should be unset, the Linode CLI will stop working until
it is set again or the CLI is reconfigured with a token.

Customizing Output
------------------

0 comments on commit 830170a

Please sign in to comment.