From 57a7cb2d4e3bf7056d5328b0c3ee46272fefd7bd Mon Sep 17 00:00:00 2001 From: Justin Santa Barbara Date: Thu, 19 Jul 2018 16:21:11 -0400 Subject: [PATCH] Update docs for config file Update the paths, and add a concrete example of a configuration file. --- docs/state.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/state.md b/docs/state.md index aa5cc12eda..c2b8c44098 100644 --- a/docs/state.md +++ b/docs/state.md @@ -42,8 +42,17 @@ Repeat for each cluster needing to be moved. ## State store configuration -State store configuration must be use with `kops` cli. It will be retrieve in order through: -+ command line argument `--config $HOME/yourconfig` or `--state s3://yourstatestore` -+ envirornment variable `export KOPS_STATE_STORE=s3://yourstatestore` -+ config file `.kops.yaml`, `$HOME/.kops.yaml`, `$HOME/.kops/config.yaml` -It assume that $HOME is correctly set. \ No newline at end of file +There are a few ways to configure your state store. In priority order: + ++ command line argument `--state s3://yourstatestore` ++ environment variable `export KOPS_STATE_STORE=s3://yourstatestore` ++ config file `$HOME/.kops.yaml` ++ config file `$HOME/.kops/config` + +### Configuration file example: + +`$HOME/.kops/config` might look like this: + +``` +kops_state_store: s3://yourstatestore +```