From 2618602ae104489ff8b29e3364f24bbdb54af77b Mon Sep 17 00:00:00 2001 From: Bobby DeSimone Date: Tue, 4 Jun 2019 15:41:27 -0700 Subject: [PATCH] docs: update upgrading.md for v0.0.5 --- docs/docs/upgrading.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/docs/upgrading.md b/docs/docs/upgrading.md index b9957b566..ecd6db6b5 100644 --- a/docs/docs/upgrading.md +++ b/docs/docs/upgrading.md @@ -13,19 +13,17 @@ This page contains the list of deprecations and important or breaking changes fo ### Breaking: POLICY_FILE removed -Usage of the POLICY_FILE envvar is no longer supported. Support for file based policy configuratin has been shifted into the new unified config file. +Usage of the POLICY_FILE envvar is no longer supported. Support for file based policy configuration has been shifted into the new unified config file. ### Important: Configuration file support added -* Pomerium now supports an optional -config flag. This flag specifies a file from which to read all configuration options. It supports yaml, json, toml and properties formats. - -* All options which can be specified via MY_SETTING style envvars can now be specified within your configuration file as key/value. The key is generally the same as the envvar name, but lower cased. See Reference Documentation for exact names. - -* Options precedence is ENV > Config > Defaults - -* The options file supports a policy key, which contains policy in the same format as POLICY_FILE. To convert an existing policy.yaml into a config.yaml, just move your policy under a policy key. +- Pomerium now supports an optional -config flag. This flag specifies a file from which to read all configuration options. It supports yaml, json, toml and properties formats. +- All options which can be specified via MY_SETTING style envvars can now be specified within your configuration file as key/value. The key is generally the same as the envvar name, but lower cased. See Reference Documentation for exact names. +- Options precedence is `environmental variables` > `configuration file` > `defaults` +- The options file supports a policy key, which contains policy in the same format as `POLICY_FILE`. To convert an existing policy.yaml into a config.yaml, just move your policy under a policy key. Old: + ```yaml - from: httpbin.corp.beyondperimeter.com to: http://httpbin @@ -36,6 +34,7 @@ Usage of the POLICY_FILE envvar is no longer supported. Support for file based ``` New: + ```yaml policy: - from: httpbin.corp.beyondperimeter.com @@ -48,4 +47,4 @@ Usage of the POLICY_FILE envvar is no longer supported. Support for file based ### Authenticate Internal Service Address -The configuration variable [Authenticate Internal Service URL](https://www.pomerium.io/reference/#authenticate-internal-service-url) must now be a valid [URL](https://golang.org/pkg/net/url/#URL) type and contain both a hostname and valid `https` schema. +The configuration variable [Authenticate Internal Service URL](https://www.pomerium.io/reference/#authenticate-internal-service-url) must now be a valid [URL](https://golang.org/pkg/net/url/#URL) type and contain both a hostname and valid `https` schema.