From 1d4314bcd76a38716f6fccd918119c1fb6ec84cf Mon Sep 17 00:00:00 2001 From: Szymon Janota Date: Fri, 22 Feb 2019 11:12:22 +0100 Subject: [PATCH 1/6] Describe isntallation CR status --- docs/kyma/docs/06-01-installation.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/kyma/docs/06-01-installation.md b/docs/kyma/docs/06-01-installation.md index 08e478dec104..0ac35fe6cabb 100644 --- a/docs/kyma/docs/06-01-installation.md +++ b/docs/kyma/docs/06-01-installation.md @@ -58,6 +58,26 @@ 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: + +| **status.state** | **YES** | State of the installation. For description of states see [the table below](#installation-states) | +| **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 From e6f05bd571aea988c966771cb774c2d10f09645d Mon Sep 17 00:00:00 2001 From: Szymon Janota Date: Fri, 22 Feb 2019 11:25:43 +0100 Subject: [PATCH 2/6] Add description field --- docs/kyma/docs/06-01-installation.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/kyma/docs/06-01-installation.md b/docs/kyma/docs/06-01-installation.md index 0ac35fe6cabb..fc2b0c41dd20 100644 --- a/docs/kyma/docs/06-01-installation.md +++ b/docs/kyma/docs/06-01-installation.md @@ -62,11 +62,12 @@ This table lists all the possible parameters of a given resource together with t This table contains description of information regarding installation progress set on Installation resource: -| **status.state** | **YES** | State of the installation. For description of states see [the table below](#installation-states) | -| **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 | +| **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 From e9e93ca86d678d411bdffd90ae43b268c2f0168f Mon Sep 17 00:00:00 2001 From: Szymon Janota Date: Fri, 22 Feb 2019 11:30:40 +0100 Subject: [PATCH 3/6] Add table header --- docs/kyma/docs/06-01-installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/kyma/docs/06-01-installation.md b/docs/kyma/docs/06-01-installation.md index fc2b0c41dd20..4906aa456f93 100644 --- a/docs/kyma/docs/06-01-installation.md +++ b/docs/kyma/docs/06-01-installation.md @@ -62,6 +62,8 @@ This table lists all the possible parameters of a given resource together with t 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. | From a5f88675443b55302e0df796e0882a11525a1568 Mon Sep 17 00:00:00 2001 From: Tomasz Papiernik Date: Tue, 26 Feb 2019 07:50:44 +0100 Subject: [PATCH 4/6] TW review/updates --- docs/kyma/docs/06-01-installation.md | 34 +++++++++++++--------------- 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/kyma/docs/06-01-installation.md b/docs/kyma/docs/06-01-installation.md index 4906aa456f93..639b69b59158 100644 --- a/docs/kyma/docs/06-01-installation.md +++ b/docs/kyma/docs/06-01-installation.md @@ -60,27 +60,25 @@ This table lists all the possible parameters of a given resource together with t ## Additional information -This table contains description of information regarding installation progress set on Installation resource: +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** | 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. | +| **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** 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 From 5083cbdb167dfd04e536777fc63a2c95ebae990d Mon Sep 17 00:00:00 2001 From: Tomasz Papiernik Date: Tue, 26 Feb 2019 07:51:18 +0100 Subject: [PATCH 5/6] Forgot one thing --- docs/kyma/docs/06-01-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kyma/docs/06-01-installation.md b/docs/kyma/docs/06-01-installation.md index 639b69b59158..7083a7701725 100644 --- a/docs/kyma/docs/06-01-installation.md +++ b/docs/kyma/docs/06-01-installation.md @@ -71,7 +71,7 @@ The Kyma Installer adds the **status** section which describes the status of Kym | **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** uses one of the following four values to describe the installation state: +The **status.state** field uses one of the following four values to describe the installation state: | State | Description | |:----------:|:-------------| From 8a791248ef4153647a3044c9eb1af03df5af9b35 Mon Sep 17 00:00:00 2001 From: Tomasz Papiernik Date: Tue, 26 Feb 2019 07:56:11 +0100 Subject: [PATCH 6/6] update formatting --- docs/kyma/docs/06-01-installation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/kyma/docs/06-01-installation.md b/docs/kyma/docs/06-01-installation.md index 7083a7701725..8ff21b849f50 100644 --- a/docs/kyma/docs/06-01-installation.md +++ b/docs/kyma/docs/06-01-installation.md @@ -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. | @@ -63,7 +63,7 @@ This table lists all the possible parameters of a given resource together with t 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. | @@ -74,7 +74,7 @@ The Kyma Installer adds the **status** section which describes the status of Kym 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. | @@ -85,5 +85,5 @@ The **status.state** field uses one of the following four values to describe the These components use this CR: | Component | Description | -|:----------:|:------| +|----------|:------| | Installer | The CR triggers the Installer to install, update or delete of the specified components. |