Skip to content

EPMDEDP-16998: docs: Update krci to 3.13.5 in docs #369

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

Open
Oleksandr123234 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

EPMDEDP-16998: docs: Update krci to 3.13.5 in docs #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/operator-guide/extensions/krakend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ To configure KrakenD as the API gateway for KubeRocketCI, follow the steps below
```

:::note
This URL should point to the ingress URL of the KrakenD API Gateway. By default, this [value](https://github.com/epam/edp-install/blob/v3.13.0/deploy-templates/values.yaml#L16) is left empty, which means that the widgets are disabled by default.
This URL should point to the ingress URL of the KrakenD API Gateway. By default, this [value](https://github.com/epam/edp-install/blob/v3.13.5/deploy-templates/values.yaml#L16) is left empty, which means that the widgets are disabled by default.
:::

2. Define the KrakenD secret:
Expand Down
6 changes: 3 additions & 3 deletions docs/operator-guide/install-kuberocketci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ There are multiple ways to deploy KubeRocketCI:
```bash
helm search repo epamedp/edp-install
NAME CHART VERSION APP VERSION DESCRIPTION
epamedp/edp-install 3.13.3 3.13.3 A Helm chart for KubeRocketCI Platform
epamedp/edp-install 3.13.5 3.13.5 A Helm chart for KubeRocketCI Platform
```

:::note
Expand Down Expand Up @@ -213,11 +213,11 @@ There are multiple ways to deploy KubeRocketCI:

7. Install platform in the **krci** namespace with the Helm tool:

Check the parameters in the installation chart [values.yaml](https://github.com/epam/edp-install/blob/v3.13.3/deploy-templates/values.yaml) file.
Check the parameters in the installation chart [values.yaml](https://github.com/epam/edp-install/blob/v3.13.5/deploy-templates/values.yaml) file.

```bash
helm install krci epamedp/edp-install --wait --timeout=900s \
--version 3.13.3 \
--version 3.13.5 \
--values values.yaml \
--namespace krci \
--create-namespace
Expand Down
2 changes: 1 addition & 1 deletion docs/operator-guide/troubleshooting/environment-creation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Failed to create an environment due to the following error:

## Cause

KubeRocketCI offers several approaches for namespace management: namespaces can be created by users, by KubeRocketCI itself, or by Argo CD. If you expect KubeRocketCI to handle namespace creation, ensure that the [cd-pipeline-operator](https://github.com/epam/edp-cd-pipeline-operator), a component of KubeRocketCI, has the necessary permissions. This permission is managed by the `manageNamespace` parameter of the [values.yaml](https://github.com/epam/edp-install/blob/v3.13.0/deploy-templates/values.yaml#L265) file.
KubeRocketCI offers several approaches for namespace management: namespaces can be created by users, by KubeRocketCI itself, or by Argo CD. If you expect KubeRocketCI to handle namespace creation, ensure that the [cd-pipeline-operator](https://github.com/epam/edp-cd-pipeline-operator), a component of KubeRocketCI, has the necessary permissions. This permission is managed by the `manageNamespace` parameter of the [values.yaml](https://github.com/epam/edp-install/blob/v3.13.5/deploy-templates/values.yaml#L264) file.

If the `manageNamespace` parameter is set to false, it means the KubeRocketCI does not have permission to create namespaces and the procedure of creating namespaces in your project is delegated to a concrete person.

Expand Down
12 changes: 6 additions & 6 deletions docs/operator-guide/upgrade/upgrade-krci-3.13.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,11 +369,11 @@ If you have DefectDojo dashboards or reports referencing the old engagement name
```yaml title="clusters/core/addons/kuberocketci/Chart.yaml"
apiVersion: v2
name: edp-install
version: 3.13.1
appVersion: 3.13.1
version: 3.13.5
appVersion: 3.13.5
dependencies:
- name: edp-install
version: 3.13.1
version: 3.13.5
repository: https://epam.github.io/edp-helm-charts/stable
```

Expand All @@ -392,17 +392,17 @@ If you have DefectDojo dashboards or reports referencing the old engagement name
helm repo update

# Confirm the target chart version is available
helm search repo epamedp/edp-install --versions | grep 3.13.1
helm search repo epamedp/edp-install --versions | grep 3.13.5

# Preview changes against your values
helm diff upgrade <release-name> epamedp/edp-install \
--version 3.13.1 \
--version 3.13.5 \
-f values.yaml \
-n <namespace>

# Run the upgrade
helm upgrade --install <release-name> epamedp/edp-install \
--version 3.13.1 \
--version 3.13.5 \
-f values.yaml \
-n <namespace> \
--timeout 10m \
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.13/operator-guide/extensions/krakend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ To configure KrakenD as the API gateway for KubeRocketCI, follow the steps below
```

:::note
This URL should point to the ingress URL of the KrakenD API Gateway. By default, this [value](https://github.com/epam/edp-install/blob/v3.13.0/deploy-templates/values.yaml#L16) is left empty, which means that the widgets are disabled by default.
This URL should point to the ingress URL of the KrakenD API Gateway. By default, this [value](https://github.com/epam/edp-install/blob/v3.13.5/deploy-templates/values.yaml#L16) is left empty, which means that the widgets are disabled by default.
:::

2. Define the KrakenD secret:
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-3.13/operator-guide/install-kuberocketci.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ There are multiple ways to deploy KubeRocketCI:
```bash
helm search repo epamedp/edp-install
NAME CHART VERSION APP VERSION DESCRIPTION
epamedp/edp-install 3.13.3 3.13.3 A Helm chart for KubeRocketCI Platform
epamedp/edp-install 3.13.5 3.13.5 A Helm chart for KubeRocketCI Platform
```

:::note
Expand Down Expand Up @@ -213,11 +213,11 @@ There are multiple ways to deploy KubeRocketCI:

7. Install platform in the **krci** namespace with the Helm tool:

Check the parameters in the installation chart [values.yaml](https://github.com/epam/edp-install/blob/v3.13.3/deploy-templates/values.yaml) file.
Check the parameters in the installation chart [values.yaml](https://github.com/epam/edp-install/blob/v3.13.5/deploy-templates/values.yaml) file.

```bash
helm install krci epamedp/edp-install --wait --timeout=900s \
--version 3.13.3 \
--version 3.13.5 \
--values values.yaml \
--namespace krci \
--create-namespace
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.13/operator-guide/troubleshooting/environment-creation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Failed to create an environment due to the following error:

## Cause

KubeRocketCI offers several approaches for namespace management: namespaces can be created by users, by KubeRocketCI itself, or by Argo CD. If you expect KubeRocketCI to handle namespace creation, ensure that the [cd-pipeline-operator](https://github.com/epam/edp-cd-pipeline-operator), a component of KubeRocketCI, has the necessary permissions. This permission is managed by the `manageNamespace` parameter of the [values.yaml](https://github.com/epam/edp-install/blob/v3.13.0/deploy-templates/values.yaml#L265) file.
KubeRocketCI offers several approaches for namespace management: namespaces can be created by users, by KubeRocketCI itself, or by Argo CD. If you expect KubeRocketCI to handle namespace creation, ensure that the [cd-pipeline-operator](https://github.com/epam/edp-cd-pipeline-operator), a component of KubeRocketCI, has the necessary permissions. This permission is managed by the `manageNamespace` parameter of the [values.yaml](https://github.com/epam/edp-install/blob/v3.13.5/deploy-templates/values.yaml#L264) file.

If the `manageNamespace` parameter is set to false, it means the KubeRocketCI does not have permission to create namespaces and the procedure of creating namespaces in your project is delegated to a concrete person.

Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-3.13/operator-guide/upgrade/upgrade-krci-3.13.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,11 +369,11 @@ If you have DefectDojo dashboards or reports referencing the old engagement name
```yaml title="clusters/core/addons/kuberocketci/Chart.yaml"
apiVersion: v2
name: edp-install
version: 3.13.1
appVersion: 3.13.1
version: 3.13.5
appVersion: 3.13.5
dependencies:
- name: edp-install
version: 3.13.1
version: 3.13.5
repository: https://epam.github.io/edp-helm-charts/stable
```

Expand All @@ -392,17 +392,17 @@ If you have DefectDojo dashboards or reports referencing the old engagement name
helm repo update

# Confirm the target chart version is available
helm search repo epamedp/edp-install --versions | grep 3.13.1
helm search repo epamedp/edp-install --versions | grep 3.13.5

# Preview changes against your values
helm diff upgrade <release-name> epamedp/edp-install \
--version 3.13.1 \
--version 3.13.5 \
-f values.yaml \
-n <namespace>

# Run the upgrade
helm upgrade --install <release-name> epamedp/edp-install \
--version 3.13.1 \
--version 3.13.5 \
-f values.yaml \
-n <namespace> \
--timeout 10m \
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.13/quick-start/platform-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ To deploy the platform, follow the steps below:
2. Deploy the platform using the `helm install` command:

```bash
helm install krci epamedp/edp-install --version 3.13.0 --create-namespace --atomic -n krci --set global.dnsWildCard=example.com
helm install krci epamedp/edp-install --version 3.13.5 --create-namespace --atomic -n krci --set global.dnsWildCard=example.com
```

3. Upon successful deployment of the KubeRocketCI Helm Chart, run the `kubectl port-forward` command:
Expand Down
Loading