Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] document deprecated environment variables #746

Merged
merged 2 commits into from
Jun 6, 2018
Merged

[doc] document deprecated environment variables #746

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87cf5d8
[doc] document deprecated environment variables
mikz Jun 6, 2018
165641e
[doc] mark experimental features
mikz Jun 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions doc/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,16 @@ Note that when deploying APIcast v2 with OpenShift, some of these parameters can
### `APICAST_BACKEND_CACHE_HANDLER`

**Values:** strict | resilient
**Default:** strict
**Default:** strict
**Deprecated:** Use [Caching](../gateway/src/apicast/policy/caching/apicast-policy.json) policy instead.

Defines how the authorization cache behaves when backend is unavailable.
Strict will remove cached application when backend is unavailable.
Resilient will do so only on getting authorization denied from backend.

### `APICAST_CONFIGURATION_CACHE`

**Values:** _a number_
**Values:** _a number_
**Default:** 0

Specifies the interval (in seconds) that the configuration will be stored for. The value should be set to 0 (not compatible with boot value of `APICAST_CONFIGURATION_LOADER`) or more than 60. For example, if `APICAST_CONFIGURATION_CACHE` is set to 120, the gateway will reload the configuration from the API manager every 2 minutes (120 seconds).
Expand All @@ -34,6 +35,8 @@ Lazy will load it on demand for each incoming request (to guarantee a complete r

### `APICAST_CUSTOM_CONFIG`

**Deprecated:** Use [policies](./policies.md) instead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should put a link to https://github.com/3scale/apicast-example-policy somewhere? Maybe in the policies.md itself...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If, then in the policies.md. Definitely not here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mayorova maybe #723 would good place to link that.


Defines the name of the Lua module that implements custom logic overriding the existing APIcast logic.

### `APICAST_ENVIRONMENT`
Expand Down Expand Up @@ -79,7 +82,8 @@ You should enable the debug level only for debugging.

### `APICAST_MODULE`

**Default:** apicast
**Default:** apicast
**Deprecated:** Use [policies](./policies.md) instead.

Specifies the name of the main Lua module that implements the API gateway logic. Custom modules can override the functionality of the default `apicast.lua` module. See [an example](../examples/custom-module) of how to use modules.

Expand All @@ -101,7 +105,7 @@ When this parameter is set to _true_, the gateway will use path-based routing in
### `APICAST_POLICY_LOAD_PATH`

**Default**: `APICAST_DIR/policies`
**Value:**: string\[:<string>\]
**Value:**: string\[:<string>\]
**Example**: ~/apicast/policies:$PWD/policies

Double colon (`:`) separated list of paths where APIcast should look for policies.
Expand All @@ -110,7 +114,7 @@ It can be used to first load policies from a development directory or to load ex
### `APICAST_PROXY_HTTPS_CERTIFICATE_KEY`

**Default:**
**Value:** string
**Value:** string
**Example:** /home/apicast/my_certificate.key

The path to the key of the client SSL certificate.
Expand Down