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

Jump to bottom

Add description of Installation status #2846

Merged
merged 6 commits into from Feb 26, 2019
Merged

Add description of Installation status #2846

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1d4314b
Describe isntallation CR status
Feb 22, 2019
e6f05bd
Add description field
Feb 22, 2019
e9e93ca
Add table header
Feb 22, 2019
a5f8867
TW review/updates
Feb 26, 2019
5083cbd
Forgot one thing
Feb 26, 2019
8a79124
update formatting
Feb 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 23 additions & 2 deletions docs/kyma/docs/06-01-installation.md
View file
Open in desktop
Expand Up @@ -47,7 +47,7 @@ spec:
This table lists all the possible parameters of a given resource together with their descriptions:

| Field | Mandatory | Description |
|:----------:|:-------------:|:------|
|----------|:-------------:|:------|
| **metadata.name** | **YES** | Specifies the name of the CR. |
| **metadata.labels.action** | **YES** | Defines the behavior of the Kyma Installer. Available options are `install` and `uninstall`. |
| **metadata.finalizers** | **NO** | Protects the CR from deletion. Read [this](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#finalizers) Kubernetes document to learn more about finalizers. |
Expand All @@ -58,11 +58,32 @@ This table lists all the possible parameters of a given resource together with t
| **spec.components.namespace** | **YES** | Defines the Namespace in which you want the Installer to install, or update the component. |
| **spec.components.release** | **NO** | Provides the name of the Helm release. The default parameter is the component name. |

## Additional information

The Kyma Installer adds the **status** section which describes the status of Kyma installation. This table lists the fields of the **status** section.

| Field | Mandatory | Description |
|----------|:-------------:|:------|
| **status.state** | **YES** | Describes the installation state. Takes one of four values. |
| **status.description** | **YES** | Describes the installation step the installer performs at the moment. |
| **status.errorLog** | **YES** | Lists all errors that happen during the installation. |
| **status.errorLog.component** | **YES** | Specifies the name of the component that causes the error. |
| **status.errorLog.log** | **YES** | Provides a description of the error. |
| **status.errorLog.occurrences** | **YES** | Specifies the number of subsequent occurrences of the error. |

The **status.state** field uses one of the following four values to describe the installation state:

| State | Description |
|----------|:-------------|
| **Installed** | Installation successful. |
| **Uninstalled** | Uninstallation successful. |
| **InProgress** | The Installer is still installing or uninstalling Kyma. No errors logged. |
| **Error** | The Installer encountered a problem but it continues to try to process the resource. |

## Related resources and components

These components use this CR:

| Component | Description |
|:----------:|:------|
|----------|:------|
| Installer | The CR triggers the Installer to install, update or delete of the specified components. |