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 3 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
23 changes: 23 additions & 0 deletions docs/kyma/docs/06-01-installation.md
View file
Open in desktop
Expand Up @@ -58,6 +58,29 @@ 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

This table contains description of information regarding installation progress set on Installation resource:

| Field | Mandatory | Description |
|:----------:|:-------------:|:------|
| **status.state** | **YES** | State of the installation. For explanation of states see [the table below](#installation-states) |
| **status.description** | **YES** | Description of the step installer is performing now. |
| **status.errorLog** | **YES** | List of errors that happened during installation so far. |
| **status.errorLog.component** | **YES** | Name of the component which installation caused the error. |
| **status.errorLog.log** | **YES** | Description of the error. |
| **status.errorLog.occurrences** | **YES** | Number of times the error has occurred ina row. |

## Installation states

Installation resource may be in following states:

| State | Description |
|:----------:|:-------------:|
| **Installed** | Installation is completed successfully. |
| **Uninstalled** | Uninstallation is completed successfully. |
| **InProgress** | Installer is still installing or uninstalling Kyma. There was no error yet. |
| **Error** | An error occurred during processing Installation, but installer is still trying to process the resource. |

## Related resources and components

Expand Down