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.

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

docs: Update Manage Quick Links page #158

Merged
merged 1 commit into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified docs/assets/user-guide/create_link_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/user-guide/delete_link_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/user-guide/delete_link_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/user-guide/edit_link_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/user-guide/edit_link_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/user-guide/links_on_the_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/user-guide/links_section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To install Nexus in environment, it's recommended to use the resources provided
## Configuration
With [Add-Ons approach](https://github.com/epam/edp-cluster-add-ons/blob/main/clusters/core) `nexus-operator` create the necessary roles,**Service Account** `ci.user`, blob stores, repository, scripts, cleanup policies automatically. Below is a comprehensive guide on how to create all resources manually.
With [Add-Ons approach](https://github.com/epam/edp-cluster-add-ons/blob/main/clusters/core) `nexus-operator` create the necessary roles, **Service Account** `ci.user`, blob stores, repository, scripts, cleanup policies automatically. Below is a comprehensive guide on how to create all resources manually.

## Configuration Nexus Repository Manager with nexus-operator

Expand Down Expand Up @@ -150,7 +150,7 @@ Without using the **nexus-operator**, manual updates are required for the Helm c

![Nexus user settings](../../assets/operator-guide/artifacts-management/nexus-settings-user.png "Nexus user settings")

6. Type the `ci.user` username, fill the following fields and click the **Create local user** button to create the ***Service Account**, fill the following fields and click **Save** button::
6. Type the `ci.user` username, fill the following fields and click the **Create local user** button to create the ***Service Account**, fill the following fields and click **Save** button:

* **ID**: `ci.user`
* **First name**: `ci.user`
Expand Down
58 changes: 44 additions & 14 deletions docs/operator-guide/upgrade/upgrade-edp-3.10.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@ import TabItem from '@theme/TabItem';
<link rel="canonical" href="https://docs.kuberocketci.io/docs/operator-guide/upgrade/upgrade-edp-3.10/" />
</head>

This section provides detailed instructions for upgrading KubeRocketCI to version 3.10. Follow the steps and requirements outlined below:

:::important
We suggest backing up the KubeRocketCI environment before starting the upgrade procedure.
We suggest backing up the KubeRocketCI environment before starting the upgrade procedure.
:::

This section provides detailed instructions for upgrading KubeRocketCI to version 3.10. Follow the steps and requirements outlined below:
:::important
The Tekton Dashboard is no longer supported in version 3.10. For more information, refer to the [Post-Upgrade Steps](#post-upgrade-steps) section.
:::

1. Update Custom Resource Definitions (CRDs). Run the following command to apply all necessary CRDs to the cluster:

Expand Down Expand Up @@ -245,7 +249,7 @@ This section provides detailed instructions for upgrading KubeRocketCI to versio
7. (Optional) Migrate SSO (OAuth2-proxy) configuration:

:::danger
Starting from version 3.10, the platform no longer supports setting single sign-on (SSO) configuration through the `edp-install` chart. This includes the installation of the `oauth2-proxy` component and the creation of required Keycloak resources.
Starting from version 3.10, the platform no longer supports setting Single Sign-on (SSO) configuration through the `edp-install` chart. This includes the installation of the `oauth2-proxy` component and the creation of required Keycloak resources.
:::

Deprecated fields in `values.yaml` file for SSO configuration are listed below:
Expand Down Expand Up @@ -454,20 +458,46 @@ This section provides detailed instructions for upgrading KubeRocketCI to versio
`helm upgrade krci epamedp/edp-install -n krci --values values.yaml --version=3.10.5 --dry-run`
:::

## Post-Upgrade Steps
## Tekton Dashboard

1. (Optional) In version 3.10, the Tekton Dashboard is migrated from the [edp-tekton](https://github.com/epam/edp-tekton) repository to a separate Helm chart in the [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons) repository. To install the Tekton Dashboard using the add-ons repository, follow the steps below:
In version 3.10, the Tekton Dashboard is migrated from the [edp-tekton](https://github.com/epam/edp-tekton) repository to a separate Helm chart in the [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons) repository. There are two approaches to install the Tekton Dashboard using the add-ons repository:

1. Clone the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/tekton-dashboard) repository.
:::note
For more information about deploying applications using [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons) repository, refer to the [Install via Add-Ons](../add-ons-overview.md) page.
:::

2. Navigate to the `clusters/core/addons/tekton-dashboard` directory and configure the `values.yaml` file with the necessary values for the Tekton Dashboard installation.
### Approach 1: Deploy Using Argo CD

3. After configuring the Tekton Dashboard Helm chart values, navigate to the `clusters/core/apps` directory. In the `values.yaml` file, update the `tekton-dashboard` section by specifying the `enable` field as `true` to enable Argo CD Application creation for the Tekton Dashboard. Also, specify the `namespace` field to define the target namespace where the Tekton Dashboard will be deployed.
The first approach implies installing the Tekton Dashboard via resource synchronization in Argo CD:

```yaml title="clusters/core/apps/values.yaml"
tekton-dashboard:
enable: true
namespace: krci
```
1. Clone the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/tekton-dashboard) repository.

2. Navigate to the `clusters/core/addons/tekton-dashboard` directory and configure the `values.yaml` file with the necessary values for the Tekton Dashboard installation.

3. After configuring the Tekton Dashboard Helm chart values, navigate to the `clusters/core/apps` directory. In the `values.yaml` file, update the `tekton-dashboard` section by specifying the `enable` field as `true` to enable Argo CD Application creation for the Tekton Dashboard. Also, specify the `namespace` field to define the target namespace where the Tekton Dashboard will be deployed.

```yaml title="clusters/core/apps/values.yaml"
tekton-dashboard:
enable: true
namespace: krci
```

4. Commit and push the changes to the remote repository. After the changes are pushed, navigate to the Argo CD and sync the Tekton Dashboard application. Verify that the Tekton Dashboard is successfully deployed.

### Approach 2: Deploy Using Helm

The first approach deploys Tekton Dashboard as a common Helm chart:

1. Clone the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/tekton-dashboard) repository.

2. Navigate to the `clusters/core/addons/tekton-dashboard` directory and configure the `values.yaml` file with the necessary values for the Tekton Dashboard installation.

3. After configuring the Tekton Dashboard Helm chart values, run the following command to deploy the Tekton Dashboard:

```bash
helm upgrade --install tekton-dashboard . -n <krci-namespace>
```

Replace `<krci-namespace>` with the target namespace where the Tekton Dashboard will be deployed.

4. Commit and push the changes to the remote repository. After the changes are pushed, navigate to the Argo CD and sync the Tekton Dashboard application. Verify that the Tekton Dashboard is successfully deployed.
4. Verify that the Tekton Dashboard is successfully deployed.
93 changes: 86 additions & 7 deletions docs/user-guide/quick-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,99 @@
<link rel="canonical" href="https://docs.kuberocketci.io/docs/user-guide/quick-links/" />
</head>

The Links section is designed to store all the component references in one place. Additional feature is to display these references directly in the [Overview](index.md) page of the KubeRocketCI portal. Some of the links are also located in the application details and stage details pages. Integrating some of the tools will also make these links clickable.
The Links section is designed to store all external references in one place. These links are displayed directly on the [Overview](index.md) page of the KubeRocketCI portal. Additionally, some links are also shown on the Component and Environment sections.

## Add Quick Link

To create a Quick Link, follow the steps below:
There are two methods to add Quick Links:

1. Navigate to **Configuration** -> **Quick Access**-> **Links** and click the **+ Add Link** button:
- [Add Quick Link via KubeRocketCI portal](#add-quick-link-via-kuberocketci-portal)
- [Add Quick Link via Helm chart](#add-quick-link-via-helm-chart)

### Add Quick Link via KubeRocketCI Portal

To add a Quick Link via the KubeRocketCI portal, follow the steps below:

1. Navigate to **Configuration** -> **Quick Access** -> **Links** and click the **+ Add Link** button:

![Links section](../assets/user-guide/links_section.png "Links section")

2. In the appeared window, insert the link name, URL, and SVG icon in base 64 format. Click the checkbox if you want your link to be displayed on the overview page and click **Apply**:
2. In the appeared window, insert the link name, URL, and SVG icon in base 64 format. Click the checkbox if it should be displayed on the **Overview** page:

![Create reference menu](../assets/user-guide/create_link_menu.png "Create reference menu")

3. If the **Show on Overview Page** option is selected, the image will be displayed on the **Overview** page among the other links:
3. If the **Show on Overview Page** option is selected, the link will be displayed on the **Overview** page:

![Added link](../assets/user-guide/links_on_the_overview.png "Added link")

### Add Quick Link via Helm Chart

The Quick Links can be specified in the [edp-install](https://github.com/epam/edp-install) Helm chart during platform installation or upgrade process.

For some components, the Quick Link section is already present in the `values.yaml` file. In this case, it is enough to specify the necessary URL for the appropriate component.

An example of the `quickLinks` section in the `values.yaml` file, with all supported components, provided below:

```yaml title="values.yaml"
quickLinks:
# Base URL value for the argocd Quick Link
argocd: ""
# Base URL value for the codemie Quick Link
codemie: ""
# Base URL value for the defectdojo Quick Link
defectdojo: ""
# Base URL value for the dependency track Quick Link
dependency_track: ""
# Base URL value for the container registry Quick Link (e.g. Nexus, DockerHub, ECR, etc.)
docker_registry: ""
# Configuration for the logging Quick Link
logging:
# -- Define the provider name for correct URL generation.
# Available providers: "opensearch", "datadog".
# If the provider name is not specified, the base URL will be used.
provider: ""
# Base URL value for the logging Quick Link
url: ""
# Configuration for the monitoring Quick Link
monitoring:
# -- Define the provider name for correct URL generation.
# Available providers: "grafana", "datadog".
# If the provider name is not specified, the base URL will be used.
provider: ""
# Base URL value for the monitoring Quick Link
url: ""
# Base URL value for the nexus Quick Link
nexus: ""
# Base URL value for the sonar Quick Link
sonar: ""
```

If the required component is not listed in the `quickLinks` section, it is possible to add the Quick Link using the `extraQuickLinks` section.

An example of specifying the Quick Link through the `extraQuickLinks` section in the `values.yaml` file is provided below:

```yaml title="values.yaml"
extraQuickLinks:
# Name of the Quick Link
- documentation:
# Base URL value for the documentation Quick Link
url: "https://docs.kuberocketci.io/"
# Visibility option for the Quick Link on the Overview page.
visible: true
# SVG icon in base 64 format.
icon: PHN2ZyB4b...
# Name of the Quick Link
- jaeger:
# Base URL value for the jaeger Quick Link
url: "https://jaeger.example.com/"
# Visibility option for the Quick Link on the Overview page.
visible: true
# SVG icon in base 64 format.
icon: PHN2ZyBoZ...
```

After specifying the necessary Quick Links in the `values.yaml` file, the Quick Links will be displayed on the **Overview** page after the platform installation.

## Edit Quick Link

To edit a Quick Link, follow the steps below:
Expand All @@ -30,13 +105,17 @@ To edit a Quick Link, follow the steps below:

![Edit link button](../assets/user-guide/edit_link_button.png "Edit link button")

2. Edit the parameters set for the link:
2. Edit the necessary fields and click **Apply**:

![Edit link menu](../assets/user-guide/edit_link_menu.png "Edit link menu")

## Delete Quick Link

Quick Links are deleted the following way:
:::note
Quick Links of type **system** cannot be deleted as they are crucial for the platform's functionality.
:::

To delete a Quick Link, follow the steps below:

1. Navigate to **Configuration** -> **Quick Access** -> **Links**. Click the three-dot menu and select **Delete**:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To install Nexus in environment, it's recommended to use the resources provided
## Configuration
With [Add-Ons approach](https://github.com/epam/edp-cluster-add-ons/blob/main/clusters/core) `nexus-operator` create the necessary roles,**Service Account** `ci.user`, blob stores, repository, scripts, cleanup policies automatically. Below is a comprehensive guide on how to create all resources manually.
With [Add-Ons approach](https://github.com/epam/edp-cluster-add-ons/blob/main/clusters/core) `nexus-operator` create the necessary roles, **Service Account** `ci.user`, blob stores, repository, scripts, cleanup policies automatically. Below is a comprehensive guide on how to create all resources manually.

## Configuration Nexus Repository Manager with nexus-operator

Expand Down Expand Up @@ -150,7 +150,7 @@ Without using the **nexus-operator**, manual updates are required for the Helm c

![Nexus user settings](../../assets/operator-guide/artifacts-management/nexus-settings-user.png "Nexus user settings")

6. Type the `ci.user` username, fill the following fields and click the **Create local user** button to create the ***Service Account**, fill the following fields and click **Save** button::
6. Type the `ci.user` username, fill the following fields and click the **Create local user** button to create the ***Service Account**, fill the following fields and click **Save** button:

* **ID**: `ci.user`
* **First name**: `ci.user`
Expand Down
Loading