-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[doc] Add placeholders in new deployment documentation (#1068)
This PR initiates the migration of the legacy deployment documentation from build/deploy/ to /deploy. It introduces placeholders to offer an opportunity for discussion about the future structure and allow a future step by step migration of the documentation.
- Loading branch information
Showing
5 changed files
with
93 additions
and
23 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
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 |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Kubernetes deployment | ||
|
||
## Introduction | ||
|
||
See [introduction](../build/pooling.md#introduction) | ||
|
||
## Architecture | ||
|
||
See [architecture](../build/deploy/README.md#architecture) | ||
|
||
### Terminology notes | ||
|
||
See [teminology notes](../build/pooling.md#terminology-notes). | ||
|
||
## Pooling | ||
|
||
### Objective | ||
|
||
See [Pooling Objective](../build/pooling.md#objective) and subsections. | ||
|
||
### Additional requirements | ||
|
||
See [Additional requirements](../build/pooling.md#additional-requirements). | ||
|
||
### Survivability | ||
|
||
See [survivability](../build/deploy/README.md#survivability). | ||
|
||
### Sizing | ||
|
||
See [sizing](../build/deploy/README.md#sizing). |
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 |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Operations | ||
|
||
This folder contains the instructions and related material used to operate a DSS. It is responsible to provide diagnostic capabilities and utilities to operate the DSS instance, such as certificates management. | ||
|
||
Currently, the operations scripts are located inside [build](../../build) and if using the [infrastructure layer](../infrastructure), helpers are generated in the workspace directory by terraform after deployment. | ||
|
||
As a complete example, the configuration files [used by the CI job](../../.github/workflows/dss-deploy.yml) of the [infrastructure](../infrastructure) and [servics](../services) layers are located in [ci](./ci). | ||
|
||
## Pooling procedure | ||
|
||
### Creating a new pool | ||
|
||
See [Creating a new pool](../../build/pooling.md#creating-a-new-pool) | ||
|
||
### Establishing a pool with first instance | ||
|
||
See [Establishing a pool with first instance](../../build/pooling.md#establishing-a-pool-with-first-instance) | ||
|
||
### Joining an existing pool with new instance | ||
|
||
See [Joining an existing pool with new instance](../../build/pooling.md#joining-an-existing-pool-with-new-instance) | ||
|
||
### Leaving a pool | ||
|
||
See [Leaving a pool](../../build/pooling.md#leaving-a-pool) | ||
|
||
## Troubleshooting | ||
|
||
See [Troubleshooting](../../build/README.md#troubleshooting) |
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
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 |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Tanka | ||
|
||
See [Tanka](../../../build/deploy/README.md#kubernetes-deployment-via-tanka) | ||
and the [legacy deployment procedure](../../../build/README.md#deploying-a-dss-instance-via-kubernetes) | ||
|
||
|