diff --git a/docs/about-platform.md b/docs/about-platform.md index f7697a3df..4d5758f05 100644 --- a/docs/about-platform.md +++ b/docs/about-platform.md @@ -19,14 +19,14 @@ The platform consists of the following blocks: ## Features -- Deployed and configured CI/CD toolset ([Tekton](https://tekton.dev/), [ArgoCD](https://argoproj.github.io/cd/), [Nexus Repository Manager](https://help.sonatype.com/repomanager3), [SonarQube](https://www.sonarqube.org/), [DefectDojo](https://www.defectdojo.org/), [Dependency-Track](https://dependencytrack.org/). +- Deployed and configured CI/CD toolset ([Tekton](https://tekton.dev/), [ArgoCD](https://argoproj.github.io/cd/), [Nexus Repository Manager](https://help.sonatype.com/en/sonatype-nexus-repository.html), [SonarQube](https://www.sonarsource.com/), [DefectDojo](https://www.defectdojo.org/), [Dependency-Track](https://dependencytrack.org/). - [GitHub](https://about.gitlab.com/features/)(by default) or [GitLab](https://about.gitlab.com/features/). - [Tekton](./operator-guide/install-tekton.md) is a pipeline orchestrator. - [CI pipelines](./user-guide/index.md) for polyglot applications: |Language|Framework|Build Tool|Application|Library|Autotest| |:-|:-:|:-:|:-:|:-:|:-:| - |Java|Java 8, Java 11, Java 17|Gradle, Maven|:white_check_mark:|:white_check_mark:|:white_check_mark:| + |Java|Java 8, Java 11, Java 17, Java 21|Gradle, Maven|:white_check_mark:|:white_check_mark:|:white_check_mark:| |Python|Python 3.8, FastAPI, Flask|Python|:white_check_mark:|:white_check_mark:|| |C#|.Net 3.1, .Net 6.0|.Net|:white_check_mark:|:white_check_mark:|| |C|None|Make,CMake|:white_check_mark:||| diff --git a/docs/assets/drawio-diagrams/krci-portal-cluster-overview.drawio b/docs/assets/drawio-diagrams/krci-portal-cluster-overview.drawio new file mode 100644 index 000000000..ec10ce3e0 --- /dev/null +++ b/docs/assets/drawio-diagrams/krci-portal-cluster-overview.drawio @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/drawio-diagrams/krci-portal-git-server-overview.drawio b/docs/assets/drawio-diagrams/krci-portal-git-server-overview.drawio new file mode 100644 index 000000000..bcad4ef4e --- /dev/null +++ b/docs/assets/drawio-diagrams/krci-portal-git-server-overview.drawio @@ -0,0 +1,70 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/assets/drawio-diagrams/krci-portal-git-server-overview.png b/docs/assets/drawio-diagrams/krci-portal-git-server-overview.png new file mode 100644 index 000000000..08e41446d Binary files /dev/null and b/docs/assets/drawio-diagrams/krci-portal-git-server-overview.png differ diff --git a/docs/assets/operator-guide/container-registry-dockerhub.png b/docs/assets/operator-guide/container-registry-dockerhub.png index 59633f94d..6f766b2e1 100644 Binary files a/docs/assets/operator-guide/container-registry-dockerhub.png and b/docs/assets/operator-guide/container-registry-dockerhub.png differ diff --git a/docs/assets/operator-guide/container-registry-ecr.png b/docs/assets/operator-guide/container-registry-ecr.png index 5324bcad9..758e363c2 100644 Binary files a/docs/assets/operator-guide/container-registry-ecr.png and b/docs/assets/operator-guide/container-registry-ecr.png differ diff --git a/docs/assets/operator-guide/container-registry-github.png b/docs/assets/operator-guide/container-registry-github.png index ff8b8ec06..14961e956 100644 Binary files a/docs/assets/operator-guide/container-registry-github.png and b/docs/assets/operator-guide/container-registry-github.png differ diff --git a/docs/assets/operator-guide/container-registry-harbor.png b/docs/assets/operator-guide/container-registry-harbor.png index 44e19253f..6faecd7e0 100644 Binary files a/docs/assets/operator-guide/container-registry-harbor.png and b/docs/assets/operator-guide/container-registry-harbor.png differ diff --git a/docs/assets/operator-guide/container-registry-list.png b/docs/assets/operator-guide/container-registry-list.png index 0c014e364..8820e7258 100644 Binary files a/docs/assets/operator-guide/container-registry-list.png and b/docs/assets/operator-guide/container-registry-list.png differ diff --git a/docs/assets/operator-guide/container-registry-nexus.png b/docs/assets/operator-guide/container-registry-nexus.png index 7db77ad68..2ad642f9f 100644 Binary files a/docs/assets/operator-guide/container-registry-nexus.png and b/docs/assets/operator-guide/container-registry-nexus.png differ diff --git a/docs/assets/operator-guide/container-registry-reset.png b/docs/assets/operator-guide/container-registry-reset.png index faee5c24d..0b9861e94 100644 Binary files a/docs/assets/operator-guide/container-registry-reset.png and b/docs/assets/operator-guide/container-registry-reset.png differ diff --git a/docs/assets/user-guide/add-available-clusters.png b/docs/assets/user-guide/add-available-clusters.png new file mode 100644 index 000000000..352daf3e6 Binary files /dev/null and b/docs/assets/user-guide/add-available-clusters.png differ diff --git a/docs/assets/user-guide/add-cluster-available-clusters.png b/docs/assets/user-guide/add-cluster-available-clusters.png new file mode 100644 index 000000000..a96048b24 Binary files /dev/null and b/docs/assets/user-guide/add-cluster-available-clusters.png differ diff --git a/docs/assets/user-guide/add-cluster-check-parameter.png b/docs/assets/user-guide/add-cluster-check-parameter.png new file mode 100644 index 000000000..788872de5 Binary files /dev/null and b/docs/assets/user-guide/add-cluster-check-parameter.png differ diff --git a/docs/assets/user-guide/add-cluster-edit-config-map.png b/docs/assets/user-guide/add-cluster-edit-config-map.png new file mode 100644 index 000000000..6ac24a9bb Binary files /dev/null and b/docs/assets/user-guide/add-cluster-edit-config-map.png differ diff --git a/docs/assets/user-guide/add-cluster-edp-config.png b/docs/assets/user-guide/add-cluster-edp-config.png new file mode 100644 index 000000000..7c7917ec5 Binary files /dev/null and b/docs/assets/user-guide/add-cluster-edp-config.png differ diff --git a/docs/assets/user-guide/add-cluster-enter-config-maps.png b/docs/assets/user-guide/add-cluster-enter-config-maps.png new file mode 100644 index 000000000..f4d11567f Binary files /dev/null and b/docs/assets/user-guide/add-cluster-enter-config-maps.png differ diff --git a/docs/assets/user-guide/add-cluster-switch-to-k8s.png b/docs/assets/user-guide/add-cluster-switch-to-k8s.png new file mode 100644 index 000000000..ca840c006 Binary files /dev/null and b/docs/assets/user-guide/add-cluster-switch-to-k8s.png differ diff --git a/docs/assets/user-guide/add_new_cluster.png b/docs/assets/user-guide/add_new_cluster.png index 40e9b110b..80b3b821a 100644 Binary files a/docs/assets/user-guide/add_new_cluster.png and b/docs/assets/user-guide/add_new_cluster.png differ diff --git a/docs/assets/user-guide/create_link_menu.png b/docs/assets/user-guide/create_link_menu.png index 6dbc1fa3b..d3938d7e5 100644 Binary files a/docs/assets/user-guide/create_link_menu.png and b/docs/assets/user-guide/create_link_menu.png differ diff --git a/docs/assets/user-guide/delete_link_button.png b/docs/assets/user-guide/delete_link_button.png index 2ee4375ef..b825a0609 100644 Binary files a/docs/assets/user-guide/delete_link_button.png and b/docs/assets/user-guide/delete_link_button.png differ diff --git a/docs/assets/user-guide/delete_link_menu.png b/docs/assets/user-guide/delete_link_menu.png index 94d2e15a0..0d674341e 100644 Binary files a/docs/assets/user-guide/delete_link_menu.png and b/docs/assets/user-guide/delete_link_menu.png differ diff --git a/docs/assets/user-guide/edit_link_button.png b/docs/assets/user-guide/edit_link_button.png index 8f57b3ff9..2190ccc45 100644 Binary files a/docs/assets/user-guide/edit_link_button.png and b/docs/assets/user-guide/edit_link_button.png differ diff --git a/docs/assets/user-guide/edit_link_menu.png b/docs/assets/user-guide/edit_link_menu.png index b83e06ee5..22c650ae5 100644 Binary files a/docs/assets/user-guide/edit_link_menu.png and b/docs/assets/user-guide/edit_link_menu.png differ diff --git a/docs/assets/user-guide/gitops-menu.png b/docs/assets/user-guide/gitops-menu.png new file mode 100644 index 000000000..570e67015 Binary files /dev/null and b/docs/assets/user-guide/gitops-menu.png differ diff --git a/docs/assets/user-guide/gitops-repo-added.png b/docs/assets/user-guide/gitops-repo-added.png new file mode 100644 index 000000000..9c7bcd247 Binary files /dev/null and b/docs/assets/user-guide/gitops-repo-added.png differ diff --git a/docs/assets/user-guide/gitops-section.png b/docs/assets/user-guide/gitops-section.png new file mode 100644 index 000000000..e1fb7accc Binary files /dev/null and b/docs/assets/user-guide/gitops-section.png differ diff --git a/docs/assets/user-guide/gitops_menu.png b/docs/assets/user-guide/gitops_menu.png deleted file mode 100644 index 2fa76701f..000000000 Binary files a/docs/assets/user-guide/gitops_menu.png and /dev/null differ diff --git a/docs/assets/user-guide/gitops_repo_added.png b/docs/assets/user-guide/gitops_repo_added.png deleted file mode 100644 index 276117e8d..000000000 Binary files a/docs/assets/user-guide/gitops_repo_added.png and /dev/null differ diff --git a/docs/assets/user-guide/gitops_section.png b/docs/assets/user-guide/gitops_section.png deleted file mode 100644 index 134e1cbce..000000000 Binary files a/docs/assets/user-guide/gitops_section.png and /dev/null differ diff --git a/docs/assets/user-guide/krci-portal-add-cluster.png b/docs/assets/user-guide/krci-portal-add-cluster.png index 36f7cbc61..f3a05392d 100644 Binary files a/docs/assets/user-guide/krci-portal-add-cluster.png and b/docs/assets/user-guide/krci-portal-add-cluster.png differ diff --git a/docs/assets/user-guide/krci-portal-cluster-overview.png b/docs/assets/user-guide/krci-portal-cluster-overview.png index e8747d195..b9b1b8f52 100644 Binary files a/docs/assets/user-guide/krci-portal-cluster-overview.png and b/docs/assets/user-guide/krci-portal-cluster-overview.png differ diff --git a/docs/assets/user-guide/krci-portal-git-server-overview.png b/docs/assets/user-guide/krci-portal-git-server-overview.png index 08e41446d..3567a5f73 100644 Binary files a/docs/assets/user-guide/krci-portal-git-server-overview.png and b/docs/assets/user-guide/krci-portal-git-server-overview.png differ diff --git a/docs/assets/user-guide/links_on_the_overview.png b/docs/assets/user-guide/links_on_the_overview.png index cb33349a2..28590bc11 100644 Binary files a/docs/assets/user-guide/links_on_the_overview.png and b/docs/assets/user-guide/links_on_the_overview.png differ diff --git a/docs/assets/user-guide/links_section.png b/docs/assets/user-guide/links_section.png index 2bdf9ec03..6c22d470b 100644 Binary files a/docs/assets/user-guide/links_section.png and b/docs/assets/user-guide/links_section.png differ diff --git a/docs/assets/user-guide/system-codebase.png b/docs/assets/user-guide/system-codebase.png new file mode 100644 index 000000000..9318066cb Binary files /dev/null and b/docs/assets/user-guide/system-codebase.png differ diff --git a/docs/assets/user-guide/system_codebase.png b/docs/assets/user-guide/system_codebase.png deleted file mode 100644 index e53b4db3e..000000000 Binary files a/docs/assets/user-guide/system_codebase.png and /dev/null differ diff --git a/docs/assets/user-guide/values-override-deploy.png b/docs/assets/user-guide/values-override-deploy.png new file mode 100644 index 000000000..86f9dca9e Binary files /dev/null and b/docs/assets/user-guide/values-override-deploy.png differ diff --git a/docs/assets/user-guide/values_override_deploy.png b/docs/assets/user-guide/values_override_deploy.png deleted file mode 100644 index 9f7b0f286..000000000 Binary files a/docs/assets/user-guide/values_override_deploy.png and /dev/null differ diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md index 210ab7892..529d4de3a 100644 --- a/docs/developer-guide/index.md +++ b/docs/developer-guide/index.md @@ -103,6 +103,6 @@ Our DockerHub repository hosts Docker images for various platform components: To maintain an active presence on social media channels and share valuable content about our software releases, we continuously publish materials across the following media: -- [SolutionsHub](https://solutionshub.epam.com/solution/epam-delivery-platform) +- [SolutionsHub](https://solutionshub.epam.com/solution/kuberocketci) - [Medium](https://medium.com/epam-delivery-platform) - [YouTube](https://www.youtube.com/@theplatformteam) diff --git a/docs/operator-guide/artifacts-management/nexus-image-registry.md b/docs/operator-guide/artifacts-management/nexus-image-registry.md index 10ef7e996..b7c3c232b 100644 --- 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/auth/platform-auth-model.md b/docs/operator-guide/auth/platform-auth-model.md index c51b4dd63..4efe9b812 100644 --- a/docs/operator-guide/auth/platform-auth-model.md +++ b/docs/operator-guide/auth/platform-auth-model.md @@ -192,7 +192,7 @@ To grant access, the appropriate role must be assigned to the user in Keycloak. ### SonarQube Configuration -[KubeRocketCI Sonar Operator](https://github.com/epam/edp-sonar-operator) provides a [SonarQube Permission Template](https://docs.sonarsource.com/sonarqube/latest/instance-administration/security/) to manage user access and permissions for SonarQube projects. +[KubeRocketCI Sonar Operator](https://github.com/epam/edp-sonar-operator) provides a [SonarQube Permission Template](https://docs.sonarsource.com/sonarqube-server/latest/instance-administration/system-functions/security/) to manage user access and permissions for SonarQube projects. The template is stored in the SonarQube [custom resource](https://github.com/epam/edp-sonar-operator/blob/master/deploy-templates/_crd_examples/permission_template.yaml) of the operator. An example of a custom resource is shown below. diff --git a/docs/operator-guide/devsecops/overview.md b/docs/operator-guide/devsecops/overview.md index 63be8e90c..7e074ae0e 100644 --- a/docs/operator-guide/devsecops/overview.md +++ b/docs/operator-guide/devsecops/overview.md @@ -40,7 +40,7 @@ For obtaining and managing report post scanning, deployment of various vulnerabi ### Gitleaks -[Gitleaks](https://github.com/zricethezav/gitleaks) is a versatile SAST tool used to scan Git repositories for hardcoded secrets, such as passwords and API keys, to prevent potential data leaks and unauthorized access. +[Gitleaks](https://github.com/gitleaks/gitleaks) is a versatile SAST tool used to scan Git repositories for hardcoded secrets, such as passwords and API keys, to prevent potential data leaks and unauthorized access. ### Trivy @@ -60,11 +60,11 @@ For obtaining and managing report post scanning, deployment of various vulnerabi ### Cdxgen -[Cdxgen](https://github.com/AppThreat/cdxgen) is a lightweight and efficient tool for generating Software Bill of Materials (SBOM) using CycloneDX, a standard format for managing component inventory. It helps organizations maintain an up-to-date record of all software components, their versions, and related vulnerabilities, streamlining monitoring and compliance within the software supply chain. +[Cdxgen](https://github.com/CycloneDX/cdxgen) is a lightweight and efficient tool for generating Software Bill of Materials (SBOM) using CycloneDX, a standard format for managing component inventory. It helps organizations maintain an up-to-date record of all software components, their versions, and related vulnerabilities, streamlining monitoring and compliance within the software supply chain. ### Semgrep CLI -[Semgrep CLI](https://github.com/returntocorp/semgrep) is a versatile and user-friendly command-line interface for the Semgrep security scanner, enabling developers to perform Static Application Security Testing (SAST) for various programming languages. It focuses on detecting and preventing potential security vulnerabilities, code quality issues, and custom anti-patterns, ensuring secure and efficient code development. +[Semgrep CLI](https://github.com/semgrep/semgrep) is a versatile and user-friendly command-line interface for the Semgrep security scanner, enabling developers to perform Static Application Security Testing (SAST) for various programming languages. It focuses on detecting and preventing potential security vulnerabilities, code quality issues, and custom anti-patterns, ensuring secure and efficient code development. ### Clair diff --git a/docs/operator-guide/project-management-and-reporting/install-reportportal.md b/docs/operator-guide/project-management-and-reporting/install-reportportal.md index d184ba684..993e5a4e5 100644 --- a/docs/operator-guide/project-management-and-reporting/install-reportportal.md +++ b/docs/operator-guide/project-management-and-reporting/install-reportportal.md @@ -667,7 +667,7 @@ To install ReportPortal, follow the steps below: :::note For user access: default/1q2w3e
For admin access: superadmin/erebus
- Please refer to the [ReportPortal.io](https://reportportal.io/installation) page for details. + Please refer to the [ReportPortal.io](https://reportportal.io/installation/) page for details. ::: :::note diff --git a/docs/operator-guide/upgrade/upgrade-edp-3.10.md b/docs/operator-guide/upgrade/upgrade-edp-3.10.md index 616c787b3..9a73a1449 100644 --- 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'; +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: @@ -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: @@ -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 + ``` + + Replace `` 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. diff --git a/docs/user-guide/add-autotest.md b/docs/user-guide/add-autotest.md index afe8f6ee8..11b47fb0c 100644 --- a/docs/user-guide/add-autotest.md +++ b/docs/user-guide/add-autotest.md @@ -64,7 +64,7 @@ In our case, we will use the **Clone** strategy: 2. Specify the autotest language properties: * **Autotest code language** - defines the code language with its supported frameworks. Selecting **Other** allows extending the default code languages and get the necessary build tool. - * **Language version/framework** - defines the specific framework or language version of the autotest. The field depends on the selected code language. Specify Java 8, Java 11 or Java 17 to be used. + * **Language version/framework** - defines the specific framework or language version of the autotest. The field depends on the selected code language. Specify Java 8, Java 11, Java 17 or Java 21 to be used. * **Build Tool** - allows to choose the build tool to use. In case of autotests, Gradle and Maven are available. * **Autotest report framework** - all the autotest reports will be created in the Allure framework by default. diff --git a/docs/user-guide/add-cluster.md b/docs/user-guide/add-cluster.md index 8aaed176d..1370eae4d 100644 --- a/docs/user-guide/add-cluster.md +++ b/docs/user-guide/add-cluster.md @@ -8,7 +8,7 @@ This page provides comprehensive instructions on how to integrate a new cluster ## Prerequisites -Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. +Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. Besides, user needs to have a cluster admin role to add clusters. ## Deploy to Remote Cluster @@ -18,7 +18,7 @@ To deploy an application to a remote cluster, follow the steps below: ![Clusters menu](../assets/user-guide/add_new_cluster.png "Clusters menu") -2. In the drop-down window, specify the required fields: +2. In the drop-down window, specify the required fields. Click the **Save** button to add the cluster: * **Cluster Name** - a unique and descriptive name for the new cluster; * **Cluster Host** - the cluster’s endpoint URL (e.g., example-cluster-domain.com); @@ -32,9 +32,31 @@ To deploy an application to a remote cluster, follow the steps below: ![Add cluster](../assets/user-guide/krci-portal-add-cluster.png "Add cluster") -3. Click the **Save** button to add the cluster. +3. As soon as the cluster is added, switch the KubeRocketCI portal to the Kubernetes mode: -As a result, the Kubernetes secret will be created for further integration and you will be able to select the integrated cluster when creating a new stage: + ![Switch to K8s](../assets/user-guide/add-cluster-switch-to-k8s.png "Switch to K8s") + +4. In the **Configuration** section, select **Config maps**: + + ![Config maps](../assets/user-guide/add-cluster-enter-config-maps.png "Config maps") + +5. In the Config maps list, enter the **edp-config** config map: + + ![Edp config](../assets/user-guide/add-cluster-edp-config.png "Edp config") + +6. In the **edp-config** config map, click the pencil icon in the top right corner of the screen: + + ![Edit config map](../assets/user-guide/add-cluster-edit-config-map.png "Edit config map") + +7. In the YAML file, add the `available_clusters` parameter, insert the cluster name, and click **Save & apply**: + + ![Add new parameter](../assets/user-guide/add-available-clusters.png "Add new parameter") + +8. Ensure the `available_clusters` parameter is added into the config map: + + ![Check added parameter](../assets/user-guide/add-cluster-check-parameter.png "Check added parameter") + +9. When adding a new environment, select the remote cluster in the **Cluster** field: ![Select cluster](../assets/user-guide/select-cluster.png "Select cluster") diff --git a/docs/user-guide/change-container-registry.md b/docs/user-guide/change-container-registry.md index a468f9f86..fd1a8e871 100644 --- a/docs/user-guide/change-container-registry.md +++ b/docs/user-guide/change-container-registry.md @@ -10,9 +10,9 @@ It may become essential to modify the container registry settings. This section Removing registry settings may disrupt your CI/CD process. New components created after changing the registry, including Components and Environments, will seamlessly function. However, existing 'Components' require additional steps, as outlined below. ::: -## Remove Container Registry +## Reset Container Registry -To remove container registry integration from the KubeRocketCI, follow the steps below: +To reset container registry integration from the KubeRocketCI, follow the steps below: 1. In the KubeRocketCI main menu, navigate to **Configuration** -> **Artifacts storage** -> **Registry**. diff --git a/docs/user-guide/configuration-overview.md b/docs/user-guide/configuration-overview.md index b50a333b7..7cd902e6a 100644 --- a/docs/user-guide/configuration-overview.md +++ b/docs/user-guide/configuration-overview.md @@ -10,20 +10,17 @@ The Configuration tab of the KubeRocketCI portal is designed to integrate KubeRo Here is the list of all the sections provided in the Configuration tab. Familiarize yourself with purposes of each section: -|Configuration Section|Description| +| Configuration Section | Description | |:-|:-| -|[Links](quick-links.md)|Configure links for quick access to required tools that will be displayed on the Overview page or in specific resource details, such as application or stage details. Additionally, this section is used to configure widgets, such as SonarQube and DependencyTrack.| -|[Nexus](../operator-guide/artifacts-management/nexus-sonatype.md)|Integrate Nexus to store and manage your application artifacts, facilitating a Continuous Integration flow within the platform.| -|[Registry](../quick-start/integrate-container-registry.md)|Integrate platform with a container registry to store container artifacts.| -|[Clusters](add-cluster.md)|Integrate platform with external clusters to enable remote cluster deployment.| -|[GitOps](gitops.md)|Onboard a specific repository used for the GitOps approach purposes.| -|[Argo CD](../operator-guide/cd/argocd-integration.md)|Integrate platform with Argo CD to enable the GitOps approach.| -|[DefectDojo](../operator-guide/devsecops/defectdojo.md)|Connect platform with DefectDojo to manage and track security defects in applications.| -|[DependencyTrack](../operator-guide/devsecops/dependency-track.md)|Connect the platform with the DependencyTrack tool for monitoring and managing vulnerabilities within third-party components.| -|[SonarQube](../operator-guide/code-quality/sonarqube.md)|Integrate SonarQube to enable static code analysis.| -|[Git Server](add-git-server.md)|Connect the platform to Version Control Systems, such as GitHub, GitLab, Bitbucket, or Gerrit for source code management.| -|[Jira](../operator-guide/project-management-and-reporting/jira-integration.md)|Integrate Jira to track and deliver the status of your projects on a dedicated dashboard.| -|[SSO](../operator-guide/auth/keycloak.md)|Integrate platform with identity provider to enable the Single Sign-On approach.| +| [Quick Access](quick-links.md) | Configure quick links for quick access to required tools that will be displayed on the Overview page or in specific resource details, such as application or stage details. Additionally, this section is used to configure widgets, such as SonarQube and DependencyTrack. | +| [Tekton](../user-guide/tekton-pipelines.md) | View all the Tekton Pipelines and Tasks CRDs created in the platform. This section allows to oversee all the Tekton resources and compare them to one another. | +| [Artifacts Storage](../user-guide/manage-container-registries.md) | This section contains settings on integrating both artifact and container registries. There are two tabs in the section: | +| [Deployment](../quick-start/integrate-container-registry.md) | This section contains settings on related to application deployment. There are three tabs in the section: | +| [Security](../operator-guide/devsecops/overview.md) | Integrate platform with [DefectDojo](../operator-guide/devsecops/defectdojo.md) and [DependencyTrack](../operator-guide/devsecops/dependency-track.md) to scan your codebases for security vulnerabilities.| +| [Code Quality](../operator-guide/code-quality/sonarqube.md) | Integrate platform with SonarQube as a mandatory component to scan your application when executing deploy pipelines. This integration also enables users to view code quality metrics and dependency scan results of your application directly in the KubeRocketCI portal. | +| [Version Control System](../user-guide/add-git-server.md) | Connect platform to a Git Server as a mandatory component to enable a CI/CD workflow. | +| [Management Tool](../operator-guide/project-management-and-reporting/jira-integration.md) | Integrate platform with a Jira server to add pull the the useful codebase metadata into Jira tickets. | +| [Gen AI](../user-guide/add-ai-assistant.md) | Integrate platform an AI assistant for getting intellectual answers to any questions in the chat. | ## Related Articles @@ -31,4 +28,4 @@ Here is the list of all the sections provided in the Configuration tab. Familiar * [Add Git Server](add-git-server.md) * [Add Cluster](add-cluster.md) * [Manage GitOps](gitops.md) -* [Manage Container Registries](../user-guide/manage-container-registries.md) +* [Manage Container Registries](manage-container-registries.md) diff --git a/docs/user-guide/git-server-overview.md b/docs/user-guide/git-server-overview.md index 4e42eb5f7..523dc5f43 100644 --- a/docs/user-guide/git-server-overview.md +++ b/docs/user-guide/git-server-overview.md @@ -20,6 +20,7 @@ To view the current Git Server, you can open Portal **Configuration** -> **Git S * **Git Server properties** - displays the Git Server type, its host address, username, SSH/HTTPS port, public and private SSH keys. * **Open documentation** - opens the "Manage Git Servers" documentation page. * **Undo/Save changes** - these buttons apply or revert changes made to the Git Server. +* **Add a new Git Server** - add a new blank to specify the new Git Server's parameters. ## View Authentication Data diff --git a/docs/user-guide/gitops.md b/docs/user-guide/gitops.md index 9f3a8afa7..e1a5e68d5 100644 --- a/docs/user-guide/gitops.md +++ b/docs/user-guide/gitops.md @@ -16,19 +16,19 @@ GitOps repository is added in two steps: 1. Navigate to **Configuration** -> **Deployment**-> **GitOps** and click the **+ Add GitOps Repository** button: - ![Required fields](../assets/user-guide/gitops_section.png "GitOps section") + ![Required fields](../assets/user-guide/gitops-section.png "GitOps section") 2. Choose one of the Git servers, fill in the required fields and click **Save**: - ![Required fields](../assets/user-guide/gitops_menu.png "GitOps menu") + ![Required fields](../assets/user-guide/gitops-menu.png "GitOps menu") 3. Check the GitOps repository connected to the platform: - ![System Codebase](../assets/user-guide/gitops_repo_added.png "System Codebase") + ![System Codebase](../assets/user-guide/gitops-repo-added.png "System Codebase") As the result, the `Codebase` of `system` type will be added to the Codebase list of the **Components** section: - ![GitOps Codebase](../assets/user-guide/system_codebase.png "GitOps Codebase") + ![GitOps Codebase](../assets/user-guide/system-codebase.png "GitOps Codebase") :::warning The platform allows only one GitOps repository at a time. @@ -44,7 +44,7 @@ Once the GitOps repository is added to the platform, you can set custom paramete 3. Navigate to the **Environments** section. Open the created environment, open its stage and deploy it with the **Values override** checkbox selected as it is shown below: - ![GitOps Codebase](../assets/user-guide/values_override_deploy.png "GitOps Codebase") + ![GitOps Codebase](../assets/user-guide/values-override-deploy.png "GitOps Codebase") ## Delete GitOps Repository diff --git a/docs/user-guide/quick-links.md b/docs/user-guide/quick-links.md index 659d8aa81..9f727577e 100644 --- a/docs/user-guide/quick-links.md +++ b/docs/user-guide/quick-links.md @@ -4,24 +4,99 @@ -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: @@ -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/static/css/cookie-consent.css b/static/css/cookie-consent.css index 6968fc1be..0288d51a4 100644 --- a/static/css/cookie-consent.css +++ b/static/css/cookie-consent.css @@ -22,7 +22,7 @@ #onetrust-banner-sdk #onetrust-policy-text, #onetrust-banner-sdk .ot-dpd-desc, #onetrust-banner-sdk .ot-b-addl-desc { - font-size: 1em !important; + font-size: 1.2em !important; } #onetrust-consent-sdk #onetrust-banner-sdk { @@ -100,4 +100,8 @@ #onetrust-banner-sdk #onetrust-policy { padding-right: 5%; +} + +#onetrust-banner-sdk #onetrust-pc-btn-handler { + font-size: 1em !important; } \ No newline at end of file diff --git a/versioned_docs/version-3.10/about-platform.md b/versioned_docs/version-3.10/about-platform.md index f7697a3df..d9f655d7d 100644 --- a/versioned_docs/version-3.10/about-platform.md +++ b/versioned_docs/version-3.10/about-platform.md @@ -19,7 +19,7 @@ The platform consists of the following blocks: ## Features -- Deployed and configured CI/CD toolset ([Tekton](https://tekton.dev/), [ArgoCD](https://argoproj.github.io/cd/), [Nexus Repository Manager](https://help.sonatype.com/repomanager3), [SonarQube](https://www.sonarqube.org/), [DefectDojo](https://www.defectdojo.org/), [Dependency-Track](https://dependencytrack.org/). +- Deployed and configured CI/CD toolset ([Tekton](https://tekton.dev/), [ArgoCD](https://argoproj.github.io/cd/), [Nexus Repository Manager](https://help.sonatype.com/en/sonatype-nexus-repository.html), [SonarQube](https://www.sonarsource.com/), [DefectDojo](https://www.defectdojo.org/), [Dependency-Track](https://dependencytrack.org/). - [GitHub](https://about.gitlab.com/features/)(by default) or [GitLab](https://about.gitlab.com/features/). - [Tekton](./operator-guide/install-tekton.md) is a pipeline orchestrator. - [CI pipelines](./user-guide/index.md) for polyglot applications: diff --git a/versioned_docs/version-3.10/assets/operator-guide/container-registry-dockerhub.png b/versioned_docs/version-3.10/assets/operator-guide/container-registry-dockerhub.png index 59633f94d..6f766b2e1 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/container-registry-dockerhub.png and b/versioned_docs/version-3.10/assets/operator-guide/container-registry-dockerhub.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/container-registry-ecr.png b/versioned_docs/version-3.10/assets/operator-guide/container-registry-ecr.png index 5324bcad9..758e363c2 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/container-registry-ecr.png and b/versioned_docs/version-3.10/assets/operator-guide/container-registry-ecr.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/container-registry-github.png b/versioned_docs/version-3.10/assets/operator-guide/container-registry-github.png index ff8b8ec06..14961e956 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/container-registry-github.png and b/versioned_docs/version-3.10/assets/operator-guide/container-registry-github.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/container-registry-harbor.png b/versioned_docs/version-3.10/assets/operator-guide/container-registry-harbor.png index 44e19253f..6faecd7e0 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/container-registry-harbor.png and b/versioned_docs/version-3.10/assets/operator-guide/container-registry-harbor.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/container-registry-list.png b/versioned_docs/version-3.10/assets/operator-guide/container-registry-list.png index 0c014e364..8820e7258 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/container-registry-list.png and b/versioned_docs/version-3.10/assets/operator-guide/container-registry-list.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/container-registry-nexus.png b/versioned_docs/version-3.10/assets/operator-guide/container-registry-nexus.png index 7db77ad68..2ad642f9f 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/container-registry-nexus.png and b/versioned_docs/version-3.10/assets/operator-guide/container-registry-nexus.png differ diff --git a/versioned_docs/version-3.10/assets/operator-guide/container-registry-reset.png b/versioned_docs/version-3.10/assets/operator-guide/container-registry-reset.png index faee5c24d..0b9861e94 100644 Binary files a/versioned_docs/version-3.10/assets/operator-guide/container-registry-reset.png and b/versioned_docs/version-3.10/assets/operator-guide/container-registry-reset.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add-available-clusters.png b/versioned_docs/version-3.10/assets/user-guide/add-available-clusters.png new file mode 100644 index 000000000..352daf3e6 Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/add-available-clusters.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add-cluster-available-clusters.png b/versioned_docs/version-3.10/assets/user-guide/add-cluster-available-clusters.png new file mode 100644 index 000000000..a96048b24 Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/add-cluster-available-clusters.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add-cluster-check-parameter.png b/versioned_docs/version-3.10/assets/user-guide/add-cluster-check-parameter.png new file mode 100644 index 000000000..788872de5 Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/add-cluster-check-parameter.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add-cluster-edit-config-map.png b/versioned_docs/version-3.10/assets/user-guide/add-cluster-edit-config-map.png new file mode 100644 index 000000000..6ac24a9bb Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/add-cluster-edit-config-map.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add-cluster-edp-config.png b/versioned_docs/version-3.10/assets/user-guide/add-cluster-edp-config.png new file mode 100644 index 000000000..7c7917ec5 Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/add-cluster-edp-config.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add-cluster-enter-config-maps.png b/versioned_docs/version-3.10/assets/user-guide/add-cluster-enter-config-maps.png new file mode 100644 index 000000000..f4d11567f Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/add-cluster-enter-config-maps.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add-cluster-switch-to-k8s.png b/versioned_docs/version-3.10/assets/user-guide/add-cluster-switch-to-k8s.png new file mode 100644 index 000000000..ca840c006 Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/add-cluster-switch-to-k8s.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/add_new_cluster.png b/versioned_docs/version-3.10/assets/user-guide/add_new_cluster.png index 40e9b110b..80b3b821a 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/add_new_cluster.png and b/versioned_docs/version-3.10/assets/user-guide/add_new_cluster.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/cluster-overview.png b/versioned_docs/version-3.10/assets/user-guide/cluster-overview.png new file mode 100644 index 000000000..e5da85f5a Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/cluster-overview.png differ 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 index 6dbc1fa3b..d3938d7e5 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/create_link_menu.png and b/versioned_docs/version-3.10/assets/user-guide/create_link_menu.png differ 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 index 2ee4375ef..b825a0609 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/delete_link_button.png and b/versioned_docs/version-3.10/assets/user-guide/delete_link_button.png differ 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 index 94d2e15a0..0d674341e 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/delete_link_menu.png and b/versioned_docs/version-3.10/assets/user-guide/delete_link_menu.png differ 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 index 8f57b3ff9..2190ccc45 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/edit_link_button.png and b/versioned_docs/version-3.10/assets/user-guide/edit_link_button.png differ 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 index b83e06ee5..22c650ae5 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/edit_link_menu.png and b/versioned_docs/version-3.10/assets/user-guide/edit_link_menu.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/gitops-menu.png b/versioned_docs/version-3.10/assets/user-guide/gitops-menu.png new file mode 100644 index 000000000..570e67015 Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/gitops-menu.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/gitops-repo-added.png b/versioned_docs/version-3.10/assets/user-guide/gitops-repo-added.png new file mode 100644 index 000000000..9c7bcd247 Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/gitops-repo-added.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/gitops-section.png b/versioned_docs/version-3.10/assets/user-guide/gitops-section.png new file mode 100644 index 000000000..e1fb7accc Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/gitops-section.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/gitops_menu.png b/versioned_docs/version-3.10/assets/user-guide/gitops_menu.png deleted file mode 100644 index 2fa76701f..000000000 Binary files a/versioned_docs/version-3.10/assets/user-guide/gitops_menu.png and /dev/null differ diff --git a/versioned_docs/version-3.10/assets/user-guide/gitops_repo_added.png b/versioned_docs/version-3.10/assets/user-guide/gitops_repo_added.png deleted file mode 100644 index 276117e8d..000000000 Binary files a/versioned_docs/version-3.10/assets/user-guide/gitops_repo_added.png and /dev/null differ diff --git a/versioned_docs/version-3.10/assets/user-guide/gitops_section.png b/versioned_docs/version-3.10/assets/user-guide/gitops_section.png deleted file mode 100644 index 134e1cbce..000000000 Binary files a/versioned_docs/version-3.10/assets/user-guide/gitops_section.png and /dev/null differ diff --git a/versioned_docs/version-3.10/assets/user-guide/krci-portal-add-cluster.png b/versioned_docs/version-3.10/assets/user-guide/krci-portal-add-cluster.png index 36f7cbc61..f3a05392d 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/krci-portal-add-cluster.png and b/versioned_docs/version-3.10/assets/user-guide/krci-portal-add-cluster.png differ 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 index cb33349a2..28590bc11 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/links_on_the_overview.png and b/versioned_docs/version-3.10/assets/user-guide/links_on_the_overview.png differ 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 index 2bdf9ec03..6c22d470b 100644 Binary files a/versioned_docs/version-3.10/assets/user-guide/links_section.png and b/versioned_docs/version-3.10/assets/user-guide/links_section.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/system-codebase.png b/versioned_docs/version-3.10/assets/user-guide/system-codebase.png new file mode 100644 index 000000000..9318066cb Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/system-codebase.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/system_codebase.png b/versioned_docs/version-3.10/assets/user-guide/system_codebase.png deleted file mode 100644 index e53b4db3e..000000000 Binary files a/versioned_docs/version-3.10/assets/user-guide/system_codebase.png and /dev/null differ diff --git a/versioned_docs/version-3.10/assets/user-guide/values-override-deploy.png b/versioned_docs/version-3.10/assets/user-guide/values-override-deploy.png new file mode 100644 index 000000000..86f9dca9e Binary files /dev/null and b/versioned_docs/version-3.10/assets/user-guide/values-override-deploy.png differ diff --git a/versioned_docs/version-3.10/assets/user-guide/values_override_deploy.png b/versioned_docs/version-3.10/assets/user-guide/values_override_deploy.png deleted file mode 100644 index 9f7b0f286..000000000 Binary files a/versioned_docs/version-3.10/assets/user-guide/values_override_deploy.png and /dev/null differ diff --git a/versioned_docs/version-3.10/developer-guide/index.md b/versioned_docs/version-3.10/developer-guide/index.md index 210ab7892..529d4de3a 100644 --- a/versioned_docs/version-3.10/developer-guide/index.md +++ b/versioned_docs/version-3.10/developer-guide/index.md @@ -103,6 +103,6 @@ Our DockerHub repository hosts Docker images for various platform components: To maintain an active presence on social media channels and share valuable content about our software releases, we continuously publish materials across the following media: -- [SolutionsHub](https://solutionshub.epam.com/solution/epam-delivery-platform) +- [SolutionsHub](https://solutionshub.epam.com/solution/kuberocketci) - [Medium](https://medium.com/epam-delivery-platform) - [YouTube](https://www.youtube.com/@theplatformteam) diff --git a/versioned_docs/version-3.10/operator-guide/artifacts-management/nexus-image-registry.md b/versioned_docs/version-3.10/operator-guide/artifacts-management/nexus-image-registry.md index 10ef7e996..b7c3c232b 100644 --- a/versioned_docs/version-3.10/operator-guide/artifacts-management/nexus-image-registry.md +++ b/versioned_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/auth/platform-auth-model.md b/versioned_docs/version-3.10/operator-guide/auth/platform-auth-model.md index bba3dee88..87e12ebd7 100644 --- a/versioned_docs/version-3.10/operator-guide/auth/platform-auth-model.md +++ b/versioned_docs/version-3.10/operator-guide/auth/platform-auth-model.md @@ -192,7 +192,7 @@ To grant access, the appropriate role must be assigned to the user in Keycloak. ### SonarQube Configuration -[KubeRocketCI Sonar Operator](https://github.com/epam/edp-sonar-operator) provides a [SonarQube Permission Template](https://docs.sonarsource.com/sonarqube/latest/instance-administration/security/) to manage user access and permissions for SonarQube projects. +[KubeRocketCI Sonar Operator](https://github.com/epam/edp-sonar-operator) provides a [SonarQube Permission Template](https://docs.sonarsource.com/sonarqube-server/latest/instance-administration/system-functions/security/) to manage user access and permissions for SonarQube projects. The template is stored in the SonarQube [custom resource](https://github.com/epam/edp-sonar-operator/blob/master/deploy-templates/_crd_examples/permission_template.yaml) of the operator. An example of a custom resource is shown below. diff --git a/versioned_docs/version-3.10/operator-guide/devsecops/overview.md b/versioned_docs/version-3.10/operator-guide/devsecops/overview.md index 63be8e90c..7e074ae0e 100644 --- a/versioned_docs/version-3.10/operator-guide/devsecops/overview.md +++ b/versioned_docs/version-3.10/operator-guide/devsecops/overview.md @@ -40,7 +40,7 @@ For obtaining and managing report post scanning, deployment of various vulnerabi ### Gitleaks -[Gitleaks](https://github.com/zricethezav/gitleaks) is a versatile SAST tool used to scan Git repositories for hardcoded secrets, such as passwords and API keys, to prevent potential data leaks and unauthorized access. +[Gitleaks](https://github.com/gitleaks/gitleaks) is a versatile SAST tool used to scan Git repositories for hardcoded secrets, such as passwords and API keys, to prevent potential data leaks and unauthorized access. ### Trivy @@ -60,11 +60,11 @@ For obtaining and managing report post scanning, deployment of various vulnerabi ### Cdxgen -[Cdxgen](https://github.com/AppThreat/cdxgen) is a lightweight and efficient tool for generating Software Bill of Materials (SBOM) using CycloneDX, a standard format for managing component inventory. It helps organizations maintain an up-to-date record of all software components, their versions, and related vulnerabilities, streamlining monitoring and compliance within the software supply chain. +[Cdxgen](https://github.com/CycloneDX/cdxgen) is a lightweight and efficient tool for generating Software Bill of Materials (SBOM) using CycloneDX, a standard format for managing component inventory. It helps organizations maintain an up-to-date record of all software components, their versions, and related vulnerabilities, streamlining monitoring and compliance within the software supply chain. ### Semgrep CLI -[Semgrep CLI](https://github.com/returntocorp/semgrep) is a versatile and user-friendly command-line interface for the Semgrep security scanner, enabling developers to perform Static Application Security Testing (SAST) for various programming languages. It focuses on detecting and preventing potential security vulnerabilities, code quality issues, and custom anti-patterns, ensuring secure and efficient code development. +[Semgrep CLI](https://github.com/semgrep/semgrep) is a versatile and user-friendly command-line interface for the Semgrep security scanner, enabling developers to perform Static Application Security Testing (SAST) for various programming languages. It focuses on detecting and preventing potential security vulnerabilities, code quality issues, and custom anti-patterns, ensuring secure and efficient code development. ### Clair diff --git a/versioned_docs/version-3.10/operator-guide/project-management-and-reporting/install-reportportal.md b/versioned_docs/version-3.10/operator-guide/project-management-and-reporting/install-reportportal.md index d184ba684..993e5a4e5 100644 --- a/versioned_docs/version-3.10/operator-guide/project-management-and-reporting/install-reportportal.md +++ b/versioned_docs/version-3.10/operator-guide/project-management-and-reporting/install-reportportal.md @@ -667,7 +667,7 @@ To install ReportPortal, follow the steps below: :::note For user access: default/1q2w3e
For admin access: superadmin/erebus
- Please refer to the [ReportPortal.io](https://reportportal.io/installation) page for details. + Please refer to the [ReportPortal.io](https://reportportal.io/installation/) page for details. ::: :::note 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 index 616c787b3..9a73a1449 100644 --- 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'; +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: @@ -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: @@ -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 + ``` + + Replace `` 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. diff --git a/versioned_docs/version-3.10/user-guide/add-cluster.md b/versioned_docs/version-3.10/user-guide/add-cluster.md index 8aaed176d..1370eae4d 100644 --- a/versioned_docs/version-3.10/user-guide/add-cluster.md +++ b/versioned_docs/version-3.10/user-guide/add-cluster.md @@ -8,7 +8,7 @@ This page provides comprehensive instructions on how to integrate a new cluster ## Prerequisites -Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. +Before moving ahead, ensure you have already performed the guidelines outlined in the [Argo CD Integration](../operator-guide/cd/argocd-integration.md#deploy-argo-cd-application-to-remote-cluster-optional) page. Besides, user needs to have a cluster admin role to add clusters. ## Deploy to Remote Cluster @@ -18,7 +18,7 @@ To deploy an application to a remote cluster, follow the steps below: ![Clusters menu](../assets/user-guide/add_new_cluster.png "Clusters menu") -2. In the drop-down window, specify the required fields: +2. In the drop-down window, specify the required fields. Click the **Save** button to add the cluster: * **Cluster Name** - a unique and descriptive name for the new cluster; * **Cluster Host** - the cluster’s endpoint URL (e.g., example-cluster-domain.com); @@ -32,9 +32,31 @@ To deploy an application to a remote cluster, follow the steps below: ![Add cluster](../assets/user-guide/krci-portal-add-cluster.png "Add cluster") -3. Click the **Save** button to add the cluster. +3. As soon as the cluster is added, switch the KubeRocketCI portal to the Kubernetes mode: -As a result, the Kubernetes secret will be created for further integration and you will be able to select the integrated cluster when creating a new stage: + ![Switch to K8s](../assets/user-guide/add-cluster-switch-to-k8s.png "Switch to K8s") + +4. In the **Configuration** section, select **Config maps**: + + ![Config maps](../assets/user-guide/add-cluster-enter-config-maps.png "Config maps") + +5. In the Config maps list, enter the **edp-config** config map: + + ![Edp config](../assets/user-guide/add-cluster-edp-config.png "Edp config") + +6. In the **edp-config** config map, click the pencil icon in the top right corner of the screen: + + ![Edit config map](../assets/user-guide/add-cluster-edit-config-map.png "Edit config map") + +7. In the YAML file, add the `available_clusters` parameter, insert the cluster name, and click **Save & apply**: + + ![Add new parameter](../assets/user-guide/add-available-clusters.png "Add new parameter") + +8. Ensure the `available_clusters` parameter is added into the config map: + + ![Check added parameter](../assets/user-guide/add-cluster-check-parameter.png "Check added parameter") + +9. When adding a new environment, select the remote cluster in the **Cluster** field: ![Select cluster](../assets/user-guide/select-cluster.png "Select cluster") diff --git a/versioned_docs/version-3.10/user-guide/change-container-registry.md b/versioned_docs/version-3.10/user-guide/change-container-registry.md index a468f9f86..fd1a8e871 100644 --- a/versioned_docs/version-3.10/user-guide/change-container-registry.md +++ b/versioned_docs/version-3.10/user-guide/change-container-registry.md @@ -10,9 +10,9 @@ It may become essential to modify the container registry settings. This section Removing registry settings may disrupt your CI/CD process. New components created after changing the registry, including Components and Environments, will seamlessly function. However, existing 'Components' require additional steps, as outlined below. ::: -## Remove Container Registry +## Reset Container Registry -To remove container registry integration from the KubeRocketCI, follow the steps below: +To reset container registry integration from the KubeRocketCI, follow the steps below: 1. In the KubeRocketCI main menu, navigate to **Configuration** -> **Artifacts storage** -> **Registry**. diff --git a/versioned_docs/version-3.10/user-guide/configuration-overview.md b/versioned_docs/version-3.10/user-guide/configuration-overview.md index b50a333b7..7cd902e6a 100644 --- a/versioned_docs/version-3.10/user-guide/configuration-overview.md +++ b/versioned_docs/version-3.10/user-guide/configuration-overview.md @@ -10,20 +10,17 @@ The Configuration tab of the KubeRocketCI portal is designed to integrate KubeRo Here is the list of all the sections provided in the Configuration tab. Familiarize yourself with purposes of each section: -|Configuration Section|Description| +| Configuration Section | Description | |:-|:-| -|[Links](quick-links.md)|Configure links for quick access to required tools that will be displayed on the Overview page or in specific resource details, such as application or stage details. Additionally, this section is used to configure widgets, such as SonarQube and DependencyTrack.| -|[Nexus](../operator-guide/artifacts-management/nexus-sonatype.md)|Integrate Nexus to store and manage your application artifacts, facilitating a Continuous Integration flow within the platform.| -|[Registry](../quick-start/integrate-container-registry.md)|Integrate platform with a container registry to store container artifacts.| -|[Clusters](add-cluster.md)|Integrate platform with external clusters to enable remote cluster deployment.| -|[GitOps](gitops.md)|Onboard a specific repository used for the GitOps approach purposes.| -|[Argo CD](../operator-guide/cd/argocd-integration.md)|Integrate platform with Argo CD to enable the GitOps approach.| -|[DefectDojo](../operator-guide/devsecops/defectdojo.md)|Connect platform with DefectDojo to manage and track security defects in applications.| -|[DependencyTrack](../operator-guide/devsecops/dependency-track.md)|Connect the platform with the DependencyTrack tool for monitoring and managing vulnerabilities within third-party components.| -|[SonarQube](../operator-guide/code-quality/sonarqube.md)|Integrate SonarQube to enable static code analysis.| -|[Git Server](add-git-server.md)|Connect the platform to Version Control Systems, such as GitHub, GitLab, Bitbucket, or Gerrit for source code management.| -|[Jira](../operator-guide/project-management-and-reporting/jira-integration.md)|Integrate Jira to track and deliver the status of your projects on a dedicated dashboard.| -|[SSO](../operator-guide/auth/keycloak.md)|Integrate platform with identity provider to enable the Single Sign-On approach.| +| [Quick Access](quick-links.md) | Configure quick links for quick access to required tools that will be displayed on the Overview page or in specific resource details, such as application or stage details. Additionally, this section is used to configure widgets, such as SonarQube and DependencyTrack. | +| [Tekton](../user-guide/tekton-pipelines.md) | View all the Tekton Pipelines and Tasks CRDs created in the platform. This section allows to oversee all the Tekton resources and compare them to one another. | +| [Artifacts Storage](../user-guide/manage-container-registries.md) | This section contains settings on integrating both artifact and container registries. There are two tabs in the section:
  • Clusters: Connect the platform to a remote cluster to deploy application into them.
  • GitOps: Create a GitOps repository to redefine parameters for application Helm charts.
  • Argo CD: Configure Argo CD integration as a mandatory component for deploying applications.
| +| [Deployment](../quick-start/integrate-container-registry.md) | This section contains settings on related to application deployment. There are three tabs in the section:
  • Nexus: Integrate platform with Nexus as an application artifact storage solution.
  • Registry: Integrate with a container registry to store container artifacts. The supported container registry solutions are AWS ECR, DockerHub, Harbor, Nexus, GitHub CR, and OpenShift CR.
| +| [Security](../operator-guide/devsecops/overview.md) | Integrate platform with [DefectDojo](../operator-guide/devsecops/defectdojo.md) and [DependencyTrack](../operator-guide/devsecops/dependency-track.md) to scan your codebases for security vulnerabilities.| +| [Code Quality](../operator-guide/code-quality/sonarqube.md) | Integrate platform with SonarQube as a mandatory component to scan your application when executing deploy pipelines. This integration also enables users to view code quality metrics and dependency scan results of your application directly in the KubeRocketCI portal. | +| [Version Control System](../user-guide/add-git-server.md) | Connect platform to a Git Server as a mandatory component to enable a CI/CD workflow. | +| [Management Tool](../operator-guide/project-management-and-reporting/jira-integration.md) | Integrate platform with a Jira server to add pull the the useful codebase metadata into Jira tickets. | +| [Gen AI](../user-guide/add-ai-assistant.md) | Integrate platform an AI assistant for getting intellectual answers to any questions in the chat. | ## Related Articles @@ -31,4 +28,4 @@ Here is the list of all the sections provided in the Configuration tab. Familiar * [Add Git Server](add-git-server.md) * [Add Cluster](add-cluster.md) * [Manage GitOps](gitops.md) -* [Manage Container Registries](../user-guide/manage-container-registries.md) +* [Manage Container Registries](manage-container-registries.md) diff --git a/versioned_docs/version-3.10/user-guide/git-server-overview.md b/versioned_docs/version-3.10/user-guide/git-server-overview.md index 4e42eb5f7..523dc5f43 100644 --- a/versioned_docs/version-3.10/user-guide/git-server-overview.md +++ b/versioned_docs/version-3.10/user-guide/git-server-overview.md @@ -20,6 +20,7 @@ To view the current Git Server, you can open Portal **Configuration** -> **Git S * **Git Server properties** - displays the Git Server type, its host address, username, SSH/HTTPS port, public and private SSH keys. * **Open documentation** - opens the "Manage Git Servers" documentation page. * **Undo/Save changes** - these buttons apply or revert changes made to the Git Server. +* **Add a new Git Server** - add a new blank to specify the new Git Server's parameters. ## View Authentication Data diff --git a/versioned_docs/version-3.10/user-guide/gitops.md b/versioned_docs/version-3.10/user-guide/gitops.md index 9f3a8afa7..e1a5e68d5 100644 --- a/versioned_docs/version-3.10/user-guide/gitops.md +++ b/versioned_docs/version-3.10/user-guide/gitops.md @@ -16,19 +16,19 @@ GitOps repository is added in two steps: 1. Navigate to **Configuration** -> **Deployment**-> **GitOps** and click the **+ Add GitOps Repository** button: - ![Required fields](../assets/user-guide/gitops_section.png "GitOps section") + ![Required fields](../assets/user-guide/gitops-section.png "GitOps section") 2. Choose one of the Git servers, fill in the required fields and click **Save**: - ![Required fields](../assets/user-guide/gitops_menu.png "GitOps menu") + ![Required fields](../assets/user-guide/gitops-menu.png "GitOps menu") 3. Check the GitOps repository connected to the platform: - ![System Codebase](../assets/user-guide/gitops_repo_added.png "System Codebase") + ![System Codebase](../assets/user-guide/gitops-repo-added.png "System Codebase") As the result, the `Codebase` of `system` type will be added to the Codebase list of the **Components** section: - ![GitOps Codebase](../assets/user-guide/system_codebase.png "GitOps Codebase") + ![GitOps Codebase](../assets/user-guide/system-codebase.png "GitOps Codebase") :::warning The platform allows only one GitOps repository at a time. @@ -44,7 +44,7 @@ Once the GitOps repository is added to the platform, you can set custom paramete 3. Navigate to the **Environments** section. Open the created environment, open its stage and deploy it with the **Values override** checkbox selected as it is shown below: - ![GitOps Codebase](../assets/user-guide/values_override_deploy.png "GitOps Codebase") + ![GitOps Codebase](../assets/user-guide/values-override-deploy.png "GitOps Codebase") ## Delete GitOps Repository diff --git a/versioned_docs/version-3.10/user-guide/quick-links.md b/versioned_docs/version-3.10/user-guide/quick-links.md index 659d8aa81..9f727577e 100644 --- a/versioned_docs/version-3.10/user-guide/quick-links.md +++ b/versioned_docs/version-3.10/user-guide/quick-links.md @@ -4,24 +4,99 @@ -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: @@ -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.9/about-platform.md b/versioned_docs/version-3.9/about-platform.md index d1d3051ed..ea9f6eb71 100644 --- a/versioned_docs/version-3.9/about-platform.md +++ b/versioned_docs/version-3.9/about-platform.md @@ -19,7 +19,7 @@ The platform consists of the following blocks: ## Features -- Deployed and configured CI/CD toolset ([Tekton](https://tekton.dev/), [ArgoCD](https://argoproj.github.io/cd/), [Nexus Repository Manager](https://help.sonatype.com/repomanager3), [SonarQube](https://www.sonarqube.org/), [DefectDojo](https://www.defectdojo.org/), [Dependency-Track](https://dependencytrack.org/). +- Deployed and configured CI/CD toolset ([Tekton](https://tekton.dev/), [ArgoCD](https://argoproj.github.io/cd/), [Nexus Repository Manager](https://help.sonatype.com/en/sonatype-nexus-repository.html), [SonarQube](https://www.sonarsource.com/), [DefectDojo](https://www.defectdojo.org/), [Dependency-Track](https://dependencytrack.org/). - [GitHub](https://about.gitlab.com/features/)(by default) or [GitLab](https://about.gitlab.com/features/). - [Tekton](./operator-guide/install-tekton.md) is a pipeline orchestrator. - [CI pipelines](./user-guide/index.md) for polyglot applications: diff --git a/versioned_docs/version-3.9/assets/user-guide/create_link_menu.png b/versioned_docs/version-3.9/assets/user-guide/create_link_menu.png index 6dbc1fa3b..d3938d7e5 100644 Binary files a/versioned_docs/version-3.9/assets/user-guide/create_link_menu.png and b/versioned_docs/version-3.9/assets/user-guide/create_link_menu.png differ diff --git a/versioned_docs/version-3.9/assets/user-guide/delete_link_button.png b/versioned_docs/version-3.9/assets/user-guide/delete_link_button.png index 2ee4375ef..b825a0609 100644 Binary files a/versioned_docs/version-3.9/assets/user-guide/delete_link_button.png and b/versioned_docs/version-3.9/assets/user-guide/delete_link_button.png differ diff --git a/versioned_docs/version-3.9/assets/user-guide/delete_link_menu.png b/versioned_docs/version-3.9/assets/user-guide/delete_link_menu.png index 94d2e15a0..0d674341e 100644 Binary files a/versioned_docs/version-3.9/assets/user-guide/delete_link_menu.png and b/versioned_docs/version-3.9/assets/user-guide/delete_link_menu.png differ diff --git a/versioned_docs/version-3.9/assets/user-guide/edit_link_button.png b/versioned_docs/version-3.9/assets/user-guide/edit_link_button.png index 8f57b3ff9..2190ccc45 100644 Binary files a/versioned_docs/version-3.9/assets/user-guide/edit_link_button.png and b/versioned_docs/version-3.9/assets/user-guide/edit_link_button.png differ diff --git a/versioned_docs/version-3.9/assets/user-guide/edit_link_menu.png b/versioned_docs/version-3.9/assets/user-guide/edit_link_menu.png index b83e06ee5..22c650ae5 100644 Binary files a/versioned_docs/version-3.9/assets/user-guide/edit_link_menu.png and b/versioned_docs/version-3.9/assets/user-guide/edit_link_menu.png differ diff --git a/versioned_docs/version-3.9/assets/user-guide/links_on_the_overview.png b/versioned_docs/version-3.9/assets/user-guide/links_on_the_overview.png index cb33349a2..28590bc11 100644 Binary files a/versioned_docs/version-3.9/assets/user-guide/links_on_the_overview.png and b/versioned_docs/version-3.9/assets/user-guide/links_on_the_overview.png differ diff --git a/versioned_docs/version-3.9/assets/user-guide/links_section.png b/versioned_docs/version-3.9/assets/user-guide/links_section.png index 2bdf9ec03..6c22d470b 100644 Binary files a/versioned_docs/version-3.9/assets/user-guide/links_section.png and b/versioned_docs/version-3.9/assets/user-guide/links_section.png differ diff --git a/versioned_docs/version-3.9/developer-guide/index.md b/versioned_docs/version-3.9/developer-guide/index.md index 210ab7892..529d4de3a 100644 --- a/versioned_docs/version-3.9/developer-guide/index.md +++ b/versioned_docs/version-3.9/developer-guide/index.md @@ -103,6 +103,6 @@ Our DockerHub repository hosts Docker images for various platform components: To maintain an active presence on social media channels and share valuable content about our software releases, we continuously publish materials across the following media: -- [SolutionsHub](https://solutionshub.epam.com/solution/epam-delivery-platform) +- [SolutionsHub](https://solutionshub.epam.com/solution/kuberocketci) - [Medium](https://medium.com/epam-delivery-platform) - [YouTube](https://www.youtube.com/@theplatformteam) diff --git a/versioned_docs/version-3.9/operator-guide/artifacts-management/nexus-image-registry.md b/versioned_docs/version-3.9/operator-guide/artifacts-management/nexus-image-registry.md index 10ef7e996..b7c3c232b 100644 --- a/versioned_docs/version-3.9/operator-guide/artifacts-management/nexus-image-registry.md +++ b/versioned_docs/version-3.9/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.9/operator-guide/auth/platform-auth-model.md b/versioned_docs/version-3.9/operator-guide/auth/platform-auth-model.md index c51b4dd63..4efe9b812 100644 --- a/versioned_docs/version-3.9/operator-guide/auth/platform-auth-model.md +++ b/versioned_docs/version-3.9/operator-guide/auth/platform-auth-model.md @@ -192,7 +192,7 @@ To grant access, the appropriate role must be assigned to the user in Keycloak. ### SonarQube Configuration -[KubeRocketCI Sonar Operator](https://github.com/epam/edp-sonar-operator) provides a [SonarQube Permission Template](https://docs.sonarsource.com/sonarqube/latest/instance-administration/security/) to manage user access and permissions for SonarQube projects. +[KubeRocketCI Sonar Operator](https://github.com/epam/edp-sonar-operator) provides a [SonarQube Permission Template](https://docs.sonarsource.com/sonarqube-server/latest/instance-administration/system-functions/security/) to manage user access and permissions for SonarQube projects. The template is stored in the SonarQube [custom resource](https://github.com/epam/edp-sonar-operator/blob/master/deploy-templates/_crd_examples/permission_template.yaml) of the operator. An example of a custom resource is shown below. diff --git a/versioned_docs/version-3.9/operator-guide/devsecops/overview.md b/versioned_docs/version-3.9/operator-guide/devsecops/overview.md index 63be8e90c..7e074ae0e 100644 --- a/versioned_docs/version-3.9/operator-guide/devsecops/overview.md +++ b/versioned_docs/version-3.9/operator-guide/devsecops/overview.md @@ -40,7 +40,7 @@ For obtaining and managing report post scanning, deployment of various vulnerabi ### Gitleaks -[Gitleaks](https://github.com/zricethezav/gitleaks) is a versatile SAST tool used to scan Git repositories for hardcoded secrets, such as passwords and API keys, to prevent potential data leaks and unauthorized access. +[Gitleaks](https://github.com/gitleaks/gitleaks) is a versatile SAST tool used to scan Git repositories for hardcoded secrets, such as passwords and API keys, to prevent potential data leaks and unauthorized access. ### Trivy @@ -60,11 +60,11 @@ For obtaining and managing report post scanning, deployment of various vulnerabi ### Cdxgen -[Cdxgen](https://github.com/AppThreat/cdxgen) is a lightweight and efficient tool for generating Software Bill of Materials (SBOM) using CycloneDX, a standard format for managing component inventory. It helps organizations maintain an up-to-date record of all software components, their versions, and related vulnerabilities, streamlining monitoring and compliance within the software supply chain. +[Cdxgen](https://github.com/CycloneDX/cdxgen) is a lightweight and efficient tool for generating Software Bill of Materials (SBOM) using CycloneDX, a standard format for managing component inventory. It helps organizations maintain an up-to-date record of all software components, their versions, and related vulnerabilities, streamlining monitoring and compliance within the software supply chain. ### Semgrep CLI -[Semgrep CLI](https://github.com/returntocorp/semgrep) is a versatile and user-friendly command-line interface for the Semgrep security scanner, enabling developers to perform Static Application Security Testing (SAST) for various programming languages. It focuses on detecting and preventing potential security vulnerabilities, code quality issues, and custom anti-patterns, ensuring secure and efficient code development. +[Semgrep CLI](https://github.com/semgrep/semgrep) is a versatile and user-friendly command-line interface for the Semgrep security scanner, enabling developers to perform Static Application Security Testing (SAST) for various programming languages. It focuses on detecting and preventing potential security vulnerabilities, code quality issues, and custom anti-patterns, ensuring secure and efficient code development. ### Clair diff --git a/versioned_docs/version-3.9/operator-guide/project-management-and-reporting/install-reportportal.md b/versioned_docs/version-3.9/operator-guide/project-management-and-reporting/install-reportportal.md index d184ba684..993e5a4e5 100644 --- a/versioned_docs/version-3.9/operator-guide/project-management-and-reporting/install-reportportal.md +++ b/versioned_docs/version-3.9/operator-guide/project-management-and-reporting/install-reportportal.md @@ -667,7 +667,7 @@ To install ReportPortal, follow the steps below: :::note For user access: default/1q2w3e
For admin access: superadmin/erebus
- Please refer to the [ReportPortal.io](https://reportportal.io/installation) page for details. + Please refer to the [ReportPortal.io](https://reportportal.io/installation/) page for details. ::: :::note diff --git a/versioned_docs/version-3.9/operator-guide/upgrade/upgrade-edp-3.10.md b/versioned_docs/version-3.9/operator-guide/upgrade/upgrade-edp-3.10.md index dd33a6375..66393a81e 100644 --- a/versioned_docs/version-3.9/operator-guide/upgrade/upgrade-edp-3.10.md +++ b/versioned_docs/version-3.9/operator-guide/upgrade/upgrade-edp-3.10.md @@ -7,11 +7,15 @@ import TabItem from '@theme/TabItem'; +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 + ``` + + Replace `` with the target namespace where the Tekton Dashboard will be deployed. + + 4. Verify that the Tekton Dashboard is successfully deployed. diff --git a/versioned_docs/version-3.9/user-guide/quick-links.md b/versioned_docs/version-3.9/user-guide/quick-links.md index 659d8aa81..c1c28336d 100644 --- a/versioned_docs/version-3.9/user-guide/quick-links.md +++ b/versioned_docs/version-3.9/user-guide/quick-links.md @@ -4,24 +4,99 @@ -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/yarn.lock b/yarn.lock index fa9360272..611ca30ec 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5541,6 +5541,11 @@ fs.realpath@^1.0.0: resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz" integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw== +fsevents@~2.3.2: + version "2.3.3" + resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz" + integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw== + function-bind@^1.1.2: version "1.1.2" resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz"