docs: Update Manage Quick Links page

KubeRocketCI · Feb 6, 2025 · 6355cf4 · 6355cf4
1 parent 8a5f7f4
commit 6355cf4
Show file tree

Hide file tree

Showing 30 changed files with 357 additions and 36 deletions.
diff --git a/docs/assets/user-guide/create_link_menu.png b/docs/assets/user-guide/create_link_menu.png
diff --git a/docs/assets/user-guide/delete_link_button.png b/docs/assets/user-guide/delete_link_button.png
diff --git a/docs/assets/user-guide/delete_link_menu.png b/docs/assets/user-guide/delete_link_menu.png
diff --git a/docs/assets/user-guide/edit_link_button.png b/docs/assets/user-guide/edit_link_button.png
diff --git a/docs/assets/user-guide/edit_link_menu.png b/docs/assets/user-guide/edit_link_menu.png
diff --git a/docs/assets/user-guide/links_on_the_overview.png b/docs/assets/user-guide/links_on_the_overview.png
diff --git a/docs/assets/user-guide/links_section.png b/docs/assets/user-guide/links_section.png
diff --git a/docs/operator-guide/artifacts-management/nexus-image-registry.md b/docs/operator-guide/artifacts-management/nexus-image-registry.md
@@ -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
 
@@ -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`

diff --git a/docs/operator-guide/upgrade/upgrade-edp-3.10.md b/docs/operator-guide/upgrade/upgrade-edp-3.10.md
@@ -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
+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:
 
@@ -456,7 +460,15 @@ This section provides detailed instructions for upgrading KubeRocketCI to versio
 
 ## Post-Upgrade Steps
 
-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:
+1. (Optional) Deploy the Tekton Dashboard:
+
+    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:
+
+    :::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.
+    :::
+
+    ### Approach 1: Deploy using Argo CD
 
     1. Clone the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/tekton-dashboard) repository.
 
@@ -471,3 +483,19 @@ This section provides detailed instructions for upgrading KubeRocketCI to versio
         ```
 
     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
+
+    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. Verify that the Tekton Dashboard is successfully deployed.
diff --git a/docs/user-guide/quick-links.md b/docs/user-guide/quick-links.md
@@ -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 is 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:
@@ -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**:
 

diff --git a/versioned_docs/version-3.10/assets/user-guide/create_link_menu.png b/versioned_docs/version-3.10/assets/user-guide/create_link_menu.png
diff --git a/versioned_docs/version-3.10/assets/user-guide/delete_link_button.png b/versioned_docs/version-3.10/assets/user-guide/delete_link_button.png
diff --git a/versioned_docs/version-3.10/assets/user-guide/delete_link_menu.png b/versioned_docs/version-3.10/assets/user-guide/delete_link_menu.png
diff --git a/versioned_docs/version-3.10/assets/user-guide/edit_link_button.png b/versioned_docs/version-3.10/assets/user-guide/edit_link_button.png
diff --git a/versioned_docs/version-3.10/assets/user-guide/edit_link_menu.png b/versioned_docs/version-3.10/assets/user-guide/edit_link_menu.png
diff --git a/versioned_docs/version-3.10/assets/user-guide/links_on_the_overview.png b/versioned_docs/version-3.10/assets/user-guide/links_on_the_overview.png
diff --git a/versioned_docs/version-3.10/assets/user-guide/links_section.png b/versioned_docs/version-3.10/assets/user-guide/links_section.png
diff --git a/...d_docs/version-3.10/operator-guide/artifacts-management/nexus-image-registry.md b/...d_docs/version-3.10/operator-guide/artifacts-management/nexus-image-registry.md
@@ -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
 
@@ -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`

diff --git a/versioned_docs/version-3.10/operator-guide/upgrade/upgrade-edp-3.10.md b/versioned_docs/version-3.10/operator-guide/upgrade/upgrade-edp-3.10.md
@@ -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
+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:
 
@@ -456,7 +460,15 @@ This section provides detailed instructions for upgrading KubeRocketCI to versio
 
 ## Post-Upgrade Steps
 
-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:
+1. (Optional) Deploy the Tekton Dashboard:
+
+    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:
+
+    :::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.
+    :::
+
+    ### Approach 1: Deploy using Argo CD
 
     1. Clone the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/tekton-dashboard) repository.
 
@@ -471,3 +483,19 @@ This section provides detailed instructions for upgrading KubeRocketCI to versio
         ```
 
     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
+
+    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. Verify that the Tekton Dashboard is successfully deployed.