forked from DevFW-CICD/edp-doc
styling test
This commit is contained in:
parent
2dcccd7922
commit
58e32c69d6
6 changed files with 28 additions and 29 deletions
|
|
@ -11,10 +11,10 @@
|
|||
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.
|
||||
|
||||
---
|
||||
|
|
|
|||
|
|
@ -6,26 +6,21 @@ Backstage is a Platform Portal for building and managing internal developer tool
|
|||
|
||||
## Main features of Backstage as a Platform Portal
|
||||
|
||||
### 🤝 Tool Integration
|
||||
- **🤝 Tool Integration**
|
||||
Backstage allows for the integration of various tools used in the development process, such as CI/CD, version control systems, monitoring, and others, into a single interface.
|
||||
|
||||
Backstage allows for the integration of various tools used in the development process, such as CI/CD, version control systems, monitoring, and others, into a single interface.
|
||||
- **🏗️ Service Management**
|
||||
It offers the ability to register and manage services and microservices, as well as monitor their status and performance.
|
||||
|
||||
### 🏗️ Service Management
|
||||
- **📚 Documentation and Learning Materials**
|
||||
Backstage includes capabilities for storing and organizing documentation, making it easier for developers to access information.
|
||||
|
||||
It offers the ability to register and manage services and microservices, as well as monitor their status and performance.
|
||||
- **🌟 Golden Paths**
|
||||
Backstage supports the concept of "Golden Paths," enabling teams to follow recommended practices for development and tool usage.
|
||||
|
||||
### 📚 Documentation and Learning Materials
|
||||
|
||||
Backstage includes capabilities for storing and organizing documentation, making it easier for developers to access information.
|
||||
|
||||
### 🌟 Golden Paths
|
||||
|
||||
Backstage supports the concept of "Golden Paths," enabling teams to follow recommended practices for development and tool usage.
|
||||
|
||||
### 🧩 Modularity and Extensibility
|
||||
|
||||
The platform allows for the creation of plugins, enabling users to customize and extend Backstage's functionality to fit their organization's needs.
|
||||
Backstage provides developers with centralized and convenient access to essential tools and resources, making it an effective solution for supporting Platform Engineering and developing an internal platform portal.
|
||||
- **🧩 Modularity and Extensibility**
|
||||
The platform allows for the creation of plugins, enabling users to customize and extend Backstage's functionality to fit their organization's needs.
|
||||
Backstage provides developers with centralized and convenient access to essential tools and resources, making it an effective solution for supporting Platform Engineering and developing an internal platform portal.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ The CI pipeline consists of several predefined steps designed to ensure quality
|
|||
- **📥 Checkout:**
|
||||
Retrieves the latest version of the repository to ensure the workflow is working with the most recent code.
|
||||
|
||||
- **📝 Linting (using xxx):**
|
||||
- **📝 Linting (using [golangci-lint](https://github.com/golangci/golangci-lint)):**
|
||||
Analyzes the code for potential issues, formatting errors, or stylistic inconsistencies.
|
||||
|
||||
- **🔑 Docker Login:**
|
||||
|
|
@ -28,7 +28,7 @@ Authenticates with your Docker registry so that the newly built image can be pus
|
|||
- **🔧 Build Application & Image:**
|
||||
Constructs the application and packages it into a Docker image.
|
||||
|
||||
- **🛡️ Vulnerability Scanning (using xxx):**
|
||||
- **🛡️ 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.
|
||||
|
||||
- **⬆️ Push Image to Registry:**
|
||||
|
|
|
|||
|
|
@ -7,10 +7,12 @@ Various telemetry tools are included in the technology stack of this repository.
|
|||
Kube-prometheus-stack contains Kubernetes manifests, Prometheus and Grafana, including preconfigured dashboards.
|
||||
|
||||
### Kube-prometheus-stack Overview
|
||||
|
||||
Grafana is an open-source monitoring solution that enables viusalization of metrics and logs.
|
||||
Prometheus is an open-source monitoring and alerting system which collects metrics from services and allows the metrics to be shown in Grafana.
|
||||
|
||||
### Adding your own dashboards
|
||||
|
||||
Examples for additional preconfigured dashboards can be found in the folder [dashboards](https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW-CICD/stacks/src/branch/development/template/stacks/monitoring/kube-prometheus/dashboards).
|
||||
|
||||
It is possible to add your own dashboards by putting them into the same folder.
|
||||
|
|
@ -22,14 +24,17 @@ It is possible to add your own dashboards by putting them into the same folder.
|
|||
Currently the preconfigured dashboards include several examples for Loki and Nginx-Ingress metrics.
|
||||
|
||||
## Loki
|
||||
|
||||
Grafana Loki is a scalable open-source log aggregation system.
|
||||
|
||||
### Loki Overview
|
||||
|
||||
Loki is started in microservices mode and contains the components ingester, distributor, querier, and query-frontend.
|
||||
It can be configured by it's helm values file.
|
||||
|
||||
## promtail
|
||||
|
||||
Grafana Promtail is an agent that ships logs to a Grafan Loki instance (log-shipper).
|
||||
|
||||
The application Grafana Promtail is started in edfbuilder/kind/stacks/core/promtail.yaml.
|
||||
The application Grafana Promtail is started in edfbuilder/kind/stacks/core/promtail.yaml.
|
||||
It can also be configured by it's helm values file.
|
||||
|
|
|
|||
|
|
@ -4,13 +4,13 @@ Keycloak is an open-source Identity and Access Management (IAM) solution that si
|
|||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
## 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.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
## Spring's PetClinic
|
||||
# Spring's PetClinic
|
||||
|
||||
The [PetClinic](https://github.com/spring-projects/spring-petclinic) has been
|
||||
Spring's example project for years and is being updated with each new version
|
||||
|
|
@ -10,7 +10,7 @@ code, builds and deploys it. This demonstrates a golden path to set up an
|
|||
entire development and deployment pipeline of an example or starter
|
||||
application.
|
||||
|
||||
### Instance Creation
|
||||
## Instance Creation
|
||||
|
||||
To instantiate a new PetClinic instance, create a new project from the
|
||||
PetClinic template in [Backstage](https://cnoe.localtest.me/create). The
|
||||
|
|
@ -21,7 +21,6 @@ template executes the following steps:
|
|||
1. Create a new git repository in Forgejo and push the merged code.
|
||||
1. 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
|
||||
push a container image into Forgejo's internal container registry.
|
||||
|
|
|
|||
Loading…
Reference in a new issue