From 6ccc09dd38518fd70166c8fed8a86d38eb169196 Mon Sep 17 00:00:00 2001 From: "franz.germann1" Date: Thu, 19 Dec 2024 15:16:21 +0100 Subject: [PATCH] unified styling --- docs/userguide/argocd.md | 4 +--- docs/userguide/ci-workflow.md | 14 +++++++------- docs/userguide/crossplane.md | 14 +++++++++----- docs/userguide/forgejo.md | 11 ++++++++--- docs/userguide/keycloak.md | 19 ++++++++++++++----- docs/userguide/openbao.md | 17 +++++++++++------ docs/userguide/petclinic.md | 6 +++--- 7 files changed, 53 insertions(+), 32 deletions(-) diff --git a/docs/userguide/argocd.md b/docs/userguide/argocd.md index c43ee01..d109411 100644 --- a/docs/userguide/argocd.md +++ b/docs/userguide/argocd.md @@ -7,15 +7,13 @@ ## Main features - **📝 Declarative Configuration Management** - Argo CD uses declarative YAML or JSON files stored in Git repositories to manage application infrastructure. These files define the desired state, ensuring that applications are consistently deployed to Kubernetes clusters with every deployment. - **☸️ Kubernetes-Native Integration** Designed specifically for Kubernetes, Argo CD integrates seamlessly within the Kubernetes ecosystem. It leverages Kubernetes’ native capabilities for managing deployments and cluster resources, aligning with GitOps principles to handle changes automatically based on the declarative configurations in Git. - **♻️ Self-Healing and Automatic Rollbacks** - -Argo CD detects drift (when the actual state of a cluster deviates from the desired state) and automatically reconciles changes to restore the desired state. It also supports automatic rollbacks in the event of deployment failures, provided policies are defined in Git configurations. + Argo CD detects drift (when the actual state of a cluster deviates from the desired state) and automatically reconciles changes to restore the desired state. It also supports automatic rollbacks in the event of deployment failures, provided policies are defined in Git configurations. --- diff --git a/docs/userguide/ci-workflow.md b/docs/userguide/ci-workflow.md index ce15a33..5743918 100644 --- a/docs/userguide/ci-workflow.md +++ b/docs/userguide/ci-workflow.md @@ -17,22 +17,22 @@ Each time you push a new commit or open a pull request, a CI workflow is initiat The CI pipeline consists of several predefined steps designed to ensure quality and security before publishing the final image: - **📥 Checkout:** -Retrieves the latest version of the repository to ensure the workflow is working with the most recent code. + Retrieves the latest version of the repository to ensure the workflow is working with the most recent code. -- **📝 Linting (using [golangci-lint](https://github.com/golangci/golangci-lint)):** -Analyzes the code for potential issues, formatting errors, or stylistic inconsistencies. +- **📝 Linting (using [golangci-lint](https://github.com/golangci/golangci-lint):** + Analyzes the code for potential issues, formatting errors, or stylistic inconsistencies. - **🔑 Docker Login:** -Authenticates with your Docker registry so that the newly built image can be pushed securely. + Authenticates with your Docker registry so that the newly built image can be pushed securely. - **🔧 Build Application & Image:** -Constructs the application and packages it into a Docker image. + Constructs the application and packages it into a Docker image. - **🛡️ Vulnerability Scanning (using [trivy](https://github.com/aquasecurity/trivy)):** -Scans the final image for known security vulnerabilities, ensuring any issues are identified and addressed early on. + Scans the final image for known security vulnerabilities, ensuring any issues are identified and addressed early on. - **⬆️ Push Image to Registry:** -Uploads the successfully built image to the Forgejo registry, making it available for deployment. + Uploads the successfully built image to the Forgejo registry, making it available for deployment. ### Monitoring Workflow Progress and Logs diff --git a/docs/userguide/crossplane.md b/docs/userguide/crossplane.md index f425ab5..3c55cd1 100644 --- a/docs/userguide/crossplane.md +++ b/docs/userguide/crossplane.md @@ -7,15 +7,19 @@ Crossplane is an open-source Kubernetes add-on that extends Kubernetes' capabili ## Main features and benefits - **☁️ Cloud Agnostic:** -Crossplane can manage resources across various cloud providers, including AWS, Azure, GCP, and others. + Crossplane can manage resources across various cloud providers, including AWS, Azure, GCP, and others. + - **🧩 Kubernetes Native:** -Crossplane leverages Kubernetes' API and control plane, making it easy to integrate with existing Kubernetes workflows and tools. + Crossplane leverages Kubernetes' API and control plane, making it easy to integrate with existing Kubernetes workflows and tools. + - **📜 Declarative Infrastructure:** -Crossplane uses Kubernetes manifests to define infrastructure resources, enabling version control and automated deployments. + Crossplane uses Kubernetes manifests to define infrastructure resources, enabling version control and automated deployments. + - **🔧 Extensible:** -Crossplane can be extended with custom resource definitions (CRDs) to represent any external resource, providing flexibility and customization. + Crossplane can be extended with custom resource definitions (CRDs) to represent any external resource, providing flexibility and customization. + - **🏗️ Composable:** -Crossplane compositions allows users to compose complex infrastructure resources from simpler building blocks, promoting modularity and reusability. + Crossplane compositions allows users to compose complex infrastructure resources from simpler building blocks, promoting modularity and reusability. --- diff --git a/docs/userguide/forgejo.md b/docs/userguide/forgejo.md index 87b7cd5..fd87b91 100644 --- a/docs/userguide/forgejo.md +++ b/docs/userguide/forgejo.md @@ -32,9 +32,14 @@ The Forgejo Registry simplifies the process of managing container images and ens **Forgejo Runner** is a tool used to execute CI/CD workflows defined in Forgejo Actions. It provides: -- **▶️ Pipeline Execution**: Runs automated tasks such as building, testing, and deploying code. -- **⚙️ Integration with Forgejo**: Seamless execution of workflows hosted on the Forgejo Git server. -- **⚒️ Image Building**: Builds Docker images and pushes them to the Forgejo Registry. +- **▶️ Pipeline Execution:** + Runs automated tasks such as building, testing, and deploying code. + +- **⚙️ Integration with Forgejo:** + Seamless execution of workflows hosted on the Forgejo Git server. + +- **⚒️ Image Building:** + Builds Docker images and pushes them to the Forgejo Registry. Forgejo Runner ensures that your CI/CD processes run smoothly and consistently. diff --git a/docs/userguide/keycloak.md b/docs/userguide/keycloak.md index d0f6902..bf50eac 100644 --- a/docs/userguide/keycloak.md +++ b/docs/userguide/keycloak.md @@ -6,11 +6,20 @@ Keycloak is an open-source Identity and Access Management (IAM) solution that si ## Main features -- **Single Sign-On (SSO):** Enable users to access multiple applications and services with a single set of credentials, reducing login fatigue and improving the user experience. -- **User Federation:** Integrate your existing user stores—such as LDAP, Active Directory, or custom databases—without re-engineering your authentication layer. -- **Role-Based Access Control (RBAC):** Assign fine-grained roles and permissions to users or groups, making it easier to manage security policies at scale. -- **Social Login & Identity Brokering:** Offer seamless authentication through providers like Google, Facebook, or GitHub, saving time by not building these integrations yourself. -- **Extensible & Customizable:** Adjust Keycloak’s behavior using custom providers, themes, or authentication flows that match your project’s unique requirements. +- **🔑 Single Sign-On (SSO):** + Enable users to access multiple applications and services with a single set of credentials, reducing login fatigue and improving the user experience. + +- **👥 User Federation:** + Integrate your existing user stores—such as LDAP, Active Directory, or custom databases—without re-engineering your authentication layer. + +- **🔒 Role-Based Access Control (RBAC):** + Assign fine-grained roles and permissions to users or groups, making it easier to manage security policies at scale. + +- **🌐 Social Login & Identity Brokering:** + Offer seamless authentication through providers like Google, Facebook, or GitHub, saving time by not building these integrations yourself. + +- **🛠️ Extensible & Customizable:** + Adjust Keycloak’s behavior using custom providers, themes, or authentication flows that match your project’s unique requirements. --- diff --git a/docs/userguide/openbao.md b/docs/userguide/openbao.md index 0c63190..6532835 100644 --- a/docs/userguide/openbao.md +++ b/docs/userguide/openbao.md @@ -11,12 +11,17 @@ OpenBao's _Encrypt as a Service_ feature makes it simple to implement data encry OpenBao's Secret Engines include: -1. **Key-Value Store** -2. **PKI** (Public Key Infrastructure) for certificate management -3. **SSH** for managing SSH credentials -4. **Transit Engine** for encrypting data without storing it -5. **Time-based One-Time Passwords** (TOTP) for two-factor authentication -6. **Kubernetes Secrets** for seamless integration with containerized applications +- **Key-Value Store** + +- **PKI** (Public Key Infrastructure) for certificate management + +- **SSH** for managing SSH credentials + +- **Transit Engine** for encrypting data without storing it + +- **Time-based One-Time Passwords** (TOTP) for two-factor authentication + +- **Kubernetes Secrets** for seamless integration with containerized applications ## 🔨 How to get it to run diff --git a/docs/userguide/petclinic.md b/docs/userguide/petclinic.md index ef4a552..b17c31d 100644 --- a/docs/userguide/petclinic.md +++ b/docs/userguide/petclinic.md @@ -17,9 +17,9 @@ PetClinic template in [Backstage](https://cnoe.localtest.me/create). The template executes the following steps: 1. Download the app source code from the given code repository -1. Apply overrides for compatibility with Forgejo Actions. -1. Create a new git repository in Forgejo and push the merged code. -1. Create a new deployment in ArgoCD. +2. Apply overrides for compatibility with Forgejo Actions. +3. Create a new git repository in Forgejo and push the merged code. +4. Create a new deployment in ArgoCD. After the code is pushed into Forgejo the configured workflows in the git repository are triggered. They compile, test and scan the project and finally