diff --git a/content/en/docs/concepts/5_platforms/CNOE/_index.md b/content/en/docs/concepts/5_platforms/CNOE/_index.md index 903f56f..dac0b04 100644 --- a/content/en/docs/concepts/5_platforms/CNOE/_index.md +++ b/content/en/docs/concepts/5_platforms/CNOE/_index.md @@ -116,7 +116,7 @@ NAMESPACE NAME SYNC STATUS HEALTH STATUS argocd argo-workflows Synced Healthy argocd argocd Synced Healthy argocd backstage Synced Healthy -argocd backstage-templates Synced Healthy +argocd included-backstage-templates Synced Healthy argocd coredns Synced Healthy argocd external-secrets Synced Healthy argocd gitea Synced Healthy diff --git a/content/en/docs/project/conceptual-onboarding/6_cnoe-showtime/_index.md b/content/en/docs/project/conceptual-onboarding/6_cnoe-showtime/_index.md index 28357df..ab7be8e 100644 --- a/content/en/docs/project/conceptual-onboarding/6_cnoe-showtime/_index.md +++ b/content/en/docs/project/conceptual-onboarding/6_cnoe-showtime/_index.md @@ -389,7 +389,7 @@ NAMESPACE NAME SYNC STATUS HEALTH STATUS argocd argo-workflows Synced Healthy argocd argocd Synced Healthy argocd backstage Synced Healthy -argocd backstage-templates Synced Healthy +argocd included-backstage-templates Synced Healthy argocd external-secrets Synced Healthy argocd gitea Synced Healthy argocd keycloak Synced Healthy diff --git a/content/en/docs/solution/tools/CNOE/included-backstage-templates/_index.md b/content/en/docs/solution/tools/CNOE/included-backstage-templates/_index.md new file mode 100644 index 0000000..8cc2ff2 --- /dev/null +++ b/content/en/docs/solution/tools/CNOE/included-backstage-templates/_index.md @@ -0,0 +1,5 @@ +--- +title: Included Backstage Templates +weight: 2 +description: Here you will find information about backstage templates that are included into idpbuilder's ref-implementation +--- \ No newline at end of file diff --git a/content/en/docs/solution/tools/CNOE/included-backstage-templates/basic-argo-workflow/_index.md b/content/en/docs/solution/tools/CNOE/included-backstage-templates/basic-argo-workflow/_index.md new file mode 100644 index 0000000..068c65e --- /dev/null +++ b/content/en/docs/solution/tools/CNOE/included-backstage-templates/basic-argo-workflow/_index.md @@ -0,0 +1,19 @@ ++++ +title = "Template for basic Argo Workflow" +weight = 4 ++++ + +# Backstage Template for Basic Argo Workflow with Spark Job + +This Backstage template YAML automates the creation of an Argo Workflow for Kubernetes that includes a basic Spark job, providing a convenient way to configure and deploy workflows involving data processing or machine learning jobs. Users can define key parameters, such as the application name and the path to the main Spark application file. The template creates necessary Kubernetes resources, publishes the application code to a Gitea Git repository, registers the application in the Backstage catalog, and deploys it via ArgoCD for easy CI/CD management. + +## Use Case + +This template is designed for teams that need a streamlined approach to deploy and manage data processing or machine learning jobs using Spark within an Argo Workflow environment. It simplifies the deployment process and integrates the application with a CI/CD pipeline. The template performs the following: + +- **Workflow and Spark Job Setup**: Defines a basic Argo Workflow and configures a Spark job using the provided application file path, ideal for data processing tasks. +- **Repository Setup**: Publishes the workflow configuration to a Gitea repository, enabling version control and easy updates to the job configuration. +- **ArgoCD Integration**: Creates an ArgoCD application to manage the Spark job deployment, ensuring continuous delivery and synchronization with Kubernetes. +- **Backstage Registration**: Registers the application in Backstage, making it easily discoverable and manageable through the Backstage catalog. + +This template boosts productivity by automating steps required for setting up Argo Workflows and Spark jobs, integrating version control, and enabling centralized management and visibility, making it ideal for projects requiring efficient deployment and scalable data processing solutions. diff --git a/content/en/docs/solution/tools/CNOE/included-backstage-templates/basic-kubernetes-deployment/_idex.md b/content/en/docs/solution/tools/CNOE/included-backstage-templates/basic-kubernetes-deployment/_idex.md new file mode 100644 index 0000000..98acba3 --- /dev/null +++ b/content/en/docs/solution/tools/CNOE/included-backstage-templates/basic-kubernetes-deployment/_idex.md @@ -0,0 +1,19 @@ ++++ +title = "Template for basic kubernetes deployment" +weight = 4 ++++ + +# Backstage Template for Kubernetes Deployment + +This Backstage template YAML automates the creation of a basic Kubernetes Deployment, aimed at simplifying the deployment and management of applications in Kubernetes for the user. The template allows users to define essential parameters, such as the application’s name, and then creates and configures the Kubernetes resources, publishes the application code to a Gitea Git repository, and registers the application in the Backstage catalog for tracking and management. + +## Use Case + +The template is designed for teams needing a streamlined approach to deploy applications in Kubernetes while automatically configuring their CI/CD pipelines. It performs the following: + +- **Deployment Creation**: A Kubernetes Deployment YAML is generated based on the provided application name, specifying a basic setup with an Nginx container. +- **Repository Setup**: Publishes the deployment code in a Gitea repository, allowing for version control and future updates. +- **ArgoCD Integration**: Automatically creates an ArgoCD application for the deployment, facilitating continuous delivery and synchronization with Kubernetes. +- **Backstage Registration**: Registers the application in Backstage to make it discoverable and manageable via the Backstage catalog. + +This template enhances productivity by automating several steps required for deployment, version control, and registration, making it ideal for projects where fast, consistent deployment and centralized management are required.