Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fix linting issues #187

Merged
merged 1 commit into from
Mar 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/developer-guide/aws-reference-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ sidebar_label: "KubeRocketCI Reference Architecture on AWS"
---
<!-- markdownlint-disable MD025 -->


# KubeRocketCI Reference Architecture on AWS

<head>
Expand Down
1 change: 0 additions & 1 deletion docs/operator-guide/advanced-installation/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sidebar_label: "Overview"

# Advanced Installation Overview: Third-Party Tools


<head>
<link rel="canonical" href="https://docs.kuberocketci.io/docs/operator-guide/advanced-installation" />
</head>
Expand Down
1 change: 0 additions & 1 deletion docs/operator-guide/cd/argocd-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,6 @@ This section provides the information on how to test the integration with Argo C

</details>


2. Check that your new Application is added to the Argo CD UI under the `edp` Project scope.

## Deploy Argo CD Application to Remote Cluster (Optional)
Expand Down
6 changes: 1 addition & 5 deletions docs/operator-guide/cd/deploy-rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,12 @@ In KubeRocketCI, RPM support allows to collect applications, store them as Nexus
- **Customizable Task Execution**: Offers flexible configuration of task execution sequences.
- **No UI**: Operates entirely without a graphical user interface, relying on code-based configurations.

#### AWX Operator:
#### AWX Operator

- **User-Friendly Interface**: Features a convenient UI for managing configurations and tasks.
- **Partial Code-Based Configurations**: Retrieves some configurations (such as Ansible tasks) directly from the repository.
- **UI-Based Configuration**: All configurations are performed within the graphical user interface.


## Default Approach

The first method to delivery RPM packages is using KubeRocketCI RPM deploy pipeline.
Expand Down Expand Up @@ -171,7 +170,6 @@ Below is a structure of a GitOps repository designed for deploying RPM packages:
```
</details>


The main configuration files description:

- **nexus.repo**: Contains the configuration for connecting to Nexus, to pull artifacts to the instance.
Expand Down Expand Up @@ -246,7 +244,6 @@ To set up RPM integration using AWX tool, follow the steps below. Completing the
```
</details>


Here is a breakdown of the scheme above:

* **package-install.yaml**: This is the main file that refers to playbooks located in the **roles** directory.
Expand Down Expand Up @@ -315,7 +312,6 @@ To set up RPM integration using AWX tool, follow the steps below. Completing the

![AWX template](../../assets/operator-guide/rpm/awx-template.png "AWX template")


4. Create application with the **rpm-package** deployment option. Refer to the [Add Application](../../user-guide/add-application.md) page for more details:

![Create RPM application](../../assets/operator-guide/rpm/rpm.gif "Create RPM application")
Expand Down
11 changes: 5 additions & 6 deletions docs/operator-guide/ci/tekton-monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,16 @@ As soon as the dashboard procedure is completed, you can track the newcoming met
The [edp-install](https://github.com/epam/edp-install/) helm chart allows to integrate tekton-pipelines metrics with the Prometheus and Grafana stack through the `edp-tekton.grafana.enabled` field in [values.yaml](https://github.com/epam/edp-install/blob/d149baeb9756bdf113996620630f9b04f896e08d/deploy-templates/values.yaml#L309) file.
To enable integration, set the `edp-tekton.grafana.enabled` field to `true` and apply the changes to the cluster.

```yaml values.yaml
edp-tekton:
grafana:
enabled: true
```
```yaml values.yaml
edp-tekton:
grafana:
enabled: true
```

After the changes are applied, the tekton-pipelines metrics will be available in the `KRCI Tekton overview` Grafana dashboard:

![Tekton dashboard](../../assets/operator-guide/grafana-dashboard-is-created.png "Tekton dashboard is created")


## Related Articles

* [Install Tekton](../install-tekton.md)
Expand Down
1 change: 0 additions & 1 deletion docs/operator-guide/devsecops/dependency-track.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import TabItem from '@theme/TabItem';
<link rel="canonical" href="https://docs.kuberocketci.io/docs/operator-guide/devsecops/dependency-track" />
</head>


This documentation guide provides comprehensive instructions for installing and integrating Dependency-Track with the KubeRocketCI.

## Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sidebar_label: "Grafana"
---
<!-- markdownlint-disable MD025 -->


# Guide: Microsoft Entra SSO Integration With Grafana

<head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,6 @@ In order to adjust the Jira server integration, add the JiraServer CR by perform
3. **Add Comments:** Required for adding external links and comments to issues.
:::



## Enable Jira During Platform Deployment

KubeRocketCI offers the capability to incorporate Jira integration as part of its deployment process. To follow this approach, please review the following parameters of the [values.yaml](https://github.com/epam/edp-install/blob/release/3.9/deploy-templates/values.yaml#L145) file. Enabling the `jira.integration` parameter creates the following custom resources:
Expand Down
1 change: 0 additions & 1 deletion docs/operator-guide/upgrade/upgrade-edp-3.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import TabItem from '@theme/TabItem';
<link rel="canonical" href="https://docs.kuberocketci.io/docs/operator-guide/upgrade/upgrade-edp-3.5" />
</head>


:::warning
We suggest making a backup of the EDP environment before starting the upgrade procedure.
:::
Expand Down
1 change: 1 addition & 0 deletions docs/user-guide/add-git-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ For [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/app-passwords
```bash
echo -n "username:AppPassword" | base64
```

:::

<Tabs
Expand Down
1 change: 0 additions & 1 deletion docs/user-guide/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ description: "Explore the essentials of codebases and onboarding strategies in K
---
<!-- markdownlint-disable MD025 -->


# Components: Codebases and Onboarding Strategies

<head>
Expand Down
1 change: 0 additions & 1 deletion docs/user-guide/gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sidebar_label: "Manage Clusters"
---
<!-- markdownlint-disable MD025 -->


# Manage GitOps

<head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
<link rel="canonical" href="https://docs.kuberocketci.io/faq/how-to/application-deployment/change-environment-variables-redeploy" />
</head>


KubeRocketCI leverages Helm charts for application deployments, with each application repository including a Helm chart located in the `deploy-templates` folder. This chart defines the default parameters used during deployment.

To customize parameters for a specific environment, a `values.yaml` file is utilized. This file provides flexibility by allowing environment-specific configurations without altering the default settings. Instead of modifying parameters directly within the `deploy-templates` directory, which we strongly discourage, a structured approach is followed by managing the `values.yaml` file in the `krci-gitops` repository. This ensures a clean and maintainable configuration process for Helm chart deployments.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sidebar_label: "Overview"

# Advanced Installation Overview: Third-Party Tools


<head>
<link rel="canonical" href="https://docs.kuberocketci.io/docs/operator-guide/advanced-installation/overview" />
</head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ The initial step involves setting up the Keycloak operator (configure connection
enable: true
```


This add-ons facilitates sets up a broker realm to manage traffic redirection between external Identity Providers (IdP) and internal clients. Additionally, it creates a shared realm that encompasses all clients, including to EKS, Sonar, Nexus, and Portal.

The [KubeRocketCI RBAC add-on](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/kuberocketci-rbac) creates Keycloak groups that are used in the KubeRocketCI platform to manage access to resources. For more details refer to the [KubeRocketCI Groups](platform-auth-model.md#groups) documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,6 @@ This section provides the information on how to test the integration with Argo C

</details>


2. Check that your new Application is added to the Argo CD UI under the `edp` Project scope.

## Deploy Argo CD Application to Remote Cluster (Optional)
Expand Down
6 changes: 1 addition & 5 deletions versioned_docs/version-3.10/operator-guide/cd/deploy-rpm.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,12 @@ In KubeRocketCI, RPM support allows to collect applications, store them as Nexus
- **Customizable Task Execution**: Offers flexible configuration of task execution sequences.
- **No UI**: Operates entirely without a graphical user interface, relying on code-based configurations.

#### AWX Operator:
#### AWX Operator

- **User-Friendly Interface**: Features a convenient UI for managing configurations and tasks.
- **Partial Code-Based Configurations**: Retrieves some configurations (such as Ansible tasks) directly from the repository.
- **UI-Based Configuration**: All configurations are performed within the graphical user interface.


## Default Approach

The first method to delivery RPM packages is using KubeRocketCI RPM deploy pipeline.
Expand Down Expand Up @@ -171,7 +170,6 @@ Below is a structure of a GitOps repository designed for deploying RPM packages:
```
</details>


The main configuration files description:

- **nexus.repo**: Contains the configuration for connecting to Nexus, to pull artifacts to the instance.
Expand Down Expand Up @@ -246,7 +244,6 @@ To set up RPM integration using AWX tool, follow the steps below. Completing the
```
</details>


Here is a breakdown of the scheme above:

* **package-install.yaml**: This is the main file that refers to playbooks located in the **roles** directory.
Expand Down Expand Up @@ -315,7 +312,6 @@ To set up RPM integration using AWX tool, follow the steps below. Completing the

![AWX template](../../assets/operator-guide/rpm/awx-template.png "AWX template")


4. Create application with the **rpm-package** deployment option. Refer to the [Add Application](../../user-guide/add-application.md) page for more details:

![Create RPM application](../../assets/operator-guide/rpm/rpm.gif "Create RPM application")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ After the changes are applied, the tekton-pipelines metrics will be available in

![Tekton dashboard](../../assets/operator-guide/grafana-dashboard-is-created.png "Tekton dashboard is created")


## Related Articles

* [Install Tekton](../install-tekton.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,6 @@ In order to adjust the Jira server integration, add the JiraServer CR by perform
3. **Add Comments:** Required for adding external links and comments to issues.
:::



## Enable Jira During Platform Deployment

KubeRocketCI offers the capability to incorporate Jira integration as part of its deployment process. To follow this approach, please review the following parameters of the [values.yaml](https://github.com/epam/edp-install/blob/release/3.9/deploy-templates/values.yaml#L145) file. Enabling the `jira.integration` parameter creates the following custom resources:
Expand Down
1 change: 0 additions & 1 deletion versioned_docs/version-3.10/user-guide/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ description: "Explore the essentials of codebases and onboarding strategies in K
---
<!-- markdownlint-disable MD025 -->


# Components: Codebases and Onboarding Strategies

<head>
Expand Down
1 change: 0 additions & 1 deletion versioned_docs/version-3.10/user-guide/gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ sidebar_label: "Manage Clusters"
---
<!-- markdownlint-disable MD025 -->


# Manage GitOps

<head>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ The initial step involves setting up the Keycloak operator (configure connection
enable: true
```


This add-ons facilitates sets up a broker realm to manage traffic redirection between external Identity Providers (IdP) and internal clients. Additionally, it creates a shared realm that encompasses all clients, including to EKS, Sonar, Nexus, and Portal.

The [KubeRocketCI RBAC add-on](https://github.com/epam/edp-cluster-add-ons/tree/main/clusters/core/addons/kuberocketci-rbac) creates Keycloak groups that are used in the KubeRocketCI platform to manage access to resources. For more details refer to the [KubeRocketCI Groups](platform-auth-model.md#groups) documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,6 @@ This section provides the information on how to test the integration with Argo C

</details>


2. Check that your new Application is added to the Argo CD UI under the `edp` Project scope.

## Deploy Argo CD Application to Remote Cluster (Optional)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,6 @@ In order to adjust the Jira server integration, add the JiraServer CR by perform
3. **Add Comments:** Required for adding external links and comments to issues.
:::



## Enable Jira During Platform Deployment

KubeRocketCI offers the capability to incorporate Jira integration as part of its deployment process. To follow this approach, please review the following parameters of the [values.yaml](https://github.com/epam/edp-install/blob/release/3.9/deploy-templates/values.yaml#L145) file. Enabling the `jira.integration` parameter creates the following custom resources:
Expand Down
Loading