-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
59 additions
and
2 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 |
---|---|---|
@@ -1,5 +1,62 @@ | ||
# Stack | ||
|
||
## Overview | ||
Stack is a set of [services](../services/index.md) that you plan to use in your application. To create an application you need to choose a stack, instances of the same application use the same stack but revisions of the stacks they use may differ. | ||
|
||
Stack is a versioned entity and can have multiple revisions. Every update made to a stack creates a new revision. | ||
|
||
## Configuration | ||
|
||
The intended use of a stack is to have a separate stack per each application or sometimes for multiple applications when they are small and alike. This way when you customize a stack you can be sure that all instances (environments) of the same application will get the update. | ||
|
||
Unlike Wodby 1.0 there's no differences between managed and custom stacks. All stacks are custom and supposed to be changed to your needs. And at the same time all stacks get updates from the included managed services. | ||
|
||
### Environment Variables | ||
|
||
You can add stack-wide environment variables from "[Stack] > Configure > Env vars" page. Such environment variables will be added to all app services' kubernetes resources during deployment in app instances that use this stack revision. | ||
|
||
An environment variable can be optionally marked as secret, when "Secret" selected the environment variable value will be stored in a kubernetes secret and won't be shown in Wodby dashboard. | ||
|
||
You can optionally limit a variable to a certain environment type, when set env var will be added only to app instances that use the selected environment type. | ||
|
||
### Annotations | ||
|
||
You can add stack-wide annotations from "[Stack] > Configure > Annotations" page. Such annotations will be added to all app services' kubernetes resources during deployment in app instances that use this stack revision. | ||
|
||
You can optionally limit an annotation to a certain environment type, when set annotations will be added only to app instances that use the selected environment type. | ||
|
||
### Tokens | ||
|
||
You can add stack-wide tokens from "[Stack] > Configure > Tokens" page. Such tokens will be added to all app services in app instances that use this stack revision. | ||
|
||
Tokens can either have a plain value or a regular expression that will be used to generate a random secret value when an app services created/updated. You can use tokens in environment variables' value. | ||
|
||
You can optionally limit a token to a certain environment type, when set tokens will be added only to app instances that use the selected environment type. | ||
|
||
### Services | ||
|
||
A stack always includes a specific revision of a service. When a new service revision issued corresponding stacks can be updated to switch to the latest revision of a service. | ||
|
||
Each service in a stack can be configured under "[Stack] > Configure > Stack services > [Service]". A service can be enabled or disabled, set as mandatory or optional. When set mandatory it cannot be excluded during new app creation. | ||
|
||
Only one service can be set as main, in this case, if a service has http endpoints, the app instance's main technical domain will target the main endpoint of the main app service. | ||
|
||
#### Replicas | ||
|
||
You can change number of replicas per service, not available for external services. | ||
|
||
#### Integrations | ||
|
||
If a service provides integrations in its manifest, you can link a specific integration from your project that satisfies requirements of a service integration. Example: OpenSMTPD service allows `smtp` typed integrations to be connected to use as relay, a user has _Brevo_ integration in her organization and selects it under "[Stack] > Configure > Stack services > OpenSMTPD > Integrations", then creates a new app with this Stack, the app will already have _Brevo_ integration connected and will use it to send emails from OpenSMTPD. | ||
|
||
Additionally, to all non-external services you can add [Variable](../integrations/variable.md) integrations. | ||
|
||
## Updates | ||
|
||
When a service in a stack gets a new revision, your stack marked as outdated and can be updated. When you update a stack, the stack in your application will not be automatically updated, you can then upgrade your application stack for each instance individually. | ||
|
||
When you create a stack by adding from a catalog this stack marked as one that _has an origin_. Such stack can be additionally _synced with origin_. This may be useful if you want to get some updates from the stack in the catalog (not all stack updates done via services, sometimes there can be an update to a stack itself like addition of a new service or a new stack-wide environment variable). | ||
|
||
## Sharing | ||
|
||
Stack is a project's entity, it can be shared between multiple projects (with writable or read-only permissions) but must be attached to at least one project. | ||
|
||
Stack is a set of [managed services](../services/index.md) for your application. |