From 756d83fa341c227ff8791a9acd0e0f5e5e87cddc Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sun, 10 Sep 2023 17:24:06 +0000 Subject: [PATCH 01/20] fix: QA -> UAT reference. And leverage titles feature of prism render js --- docs/deploy-applications/docusaurs.md | 27 ++++++++++--------------- docs/deploy-applications/hello-world.md | 24 +++++++++------------- docs/deploy-applications/python-app.md | 24 +++++++++------------- 3 files changed, 29 insertions(+), 46 deletions(-) diff --git a/docs/deploy-applications/docusaurs.md b/docs/deploy-applications/docusaurs.md index b629656cd..3b72d2651 100644 --- a/docs/deploy-applications/docusaurs.md +++ b/docs/deploy-applications/docusaurs.md @@ -19,7 +19,7 @@ GlueOps relies on Docker images to deploy applications. We'll set up GitHub Acti - Copy and paste the following code into `ghcr.yaml`: -```yaml +```yaml title=".github/workflows/ghcr.yaml" name: GlueOps Action on: [push] @@ -39,7 +39,7 @@ GlueOps only supports container images published to the supported registry. ### Create Dockerfile Create a `Dockerfile` using the template below -``` +```Dockerfile title="Dockerfile" FROM httpd:2.4.57 COPY index.html /usr/local/apache2/htdocs/index.html @@ -73,8 +73,7 @@ Each workflow file uses the `GlueOps/github-workflows/.github/workflows/argocd-t In the `prod-ci.yaml` file add the following content: -```yaml -# .github/workflows/prod-ci.yaml +```yaml title=".github/workflows/prod-ci.yaml" name: ArgoCD - Prod Tags CI @@ -100,8 +99,8 @@ Replace `GH_TOKEN` with your secret name. In the `stage-ci.yaml` file add the following content: -```yaml -# .github/workflows/stage-ci.yaml +```yaml title=".github/workflows/stage-ci.yaml" + name: ArgoCD - Staging Tags CI @@ -129,10 +128,10 @@ Replace `GH_TOKEN` with your secret name. In the `uat-ci.yaml` file add the following content: -```yaml -# .github/workflows/uat-ci.yaml +```yaml title=".github/workflows/uat-ci.yaml" -name: ArgoCD - QA Tags CI + +name: ArgoCD - UAT Tags CI on: release: @@ -188,9 +187,7 @@ Replace `venkata-tenant-test-1/docusaurus-website` with your organization and re Create a file named `values.yaml` in the `envs/prod` folder and add the following content: -```yaml -# envs/prod/values.yaml - +```yaml title="envs/prod/values.yaml" image: tag: 'v0.2.0' @@ -221,8 +218,7 @@ Replace the placeholders as follows: Create a file named `values.yaml` in the `envs/stage` folder and add the following content: -```yaml -# envs/stage/values.yaml +```yaml title="envs/stage/values.yaml" image: tag: 'latest' @@ -253,8 +249,7 @@ Replace the placeholders as follows: Create a file named `values.yaml` in the `envs/uat` folder and add the following content: -```yaml -# envs/uat/values.yaml +```yaml title="envs/uat/values.yaml" image: tag: 'v0.1.0' diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index e95170b5d..d6c034be3 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -33,7 +33,7 @@ Now, let's configure GitHub Actions to automatically publish a Docker image of y 2. Create a new file named `ghcr.yaml` in the `workflows` folder. 3. Copy and paste the following code into `ghcr.yaml`: -```yaml +```yaml title=".github/workflows/ghcr.yaml" name: GlueOps Action on: [push] @@ -53,7 +53,7 @@ GlueOps only supports container images published to the supported registry. ### Create Dockerfile Create a `Dockerfile` using the template below -``` +```Dockerfile title="Dockerfile" FROM httpd:2.4.57 COPY index.html /usr/local/apache2/htdocs/index.html @@ -89,8 +89,7 @@ In the `prod-ci.yaml` file add the following content: Replace `GH_TOKEN` with your secret name. ::: -```yaml -# .github/workflows/prod-ci.yaml +```yaml title=".github/workflows/prod-ci.yaml" name: ArgoCD - Prod Tags CI @@ -116,8 +115,7 @@ Replace `GH_TOKEN` with your secret name. In the `stage-ci.yaml` file add the following content: -```yaml -# .github/workflows/stage-ci.yaml +```yaml title=".github/workflows/stage-ci.yaml" name: ArgoCD - Staging Tags CI @@ -144,10 +142,9 @@ Replace `GH_TOKEN` with your secret name. In the `uat-ci.yaml` file add the following content: -```yaml -# .github/workflows/uat-ci.yaml +```yaml title=".github/workflows/uat-ci.yaml" -name: ArgoCD - QA Tags CI +name: ArgoCD - UAT Tags CI on: release: @@ -204,8 +201,7 @@ Replace `venkata-tenant-test-1/demo-app-1` with your organization and repository Create a file named `values.yaml` in the `envs/prod` folder and add the following content: -```yaml -# envs/prod/values.yaml +```yaml title="envs/prod/values.yaml" image: tag: 'v0.2.0' @@ -237,8 +233,7 @@ Replace the placeholders as follows: Create a file named `values.yaml` in the `envs/stage` folder and add the following content: -```yaml -# envs/stage/values.yaml +```yaml title="envs/stage/values.yaml" image: tag: 'latest' @@ -270,8 +265,7 @@ Replace the placeholders as follows: Create a file named `values.yaml` in the `envs/uat` folder and add the following content: -```yaml -# envs/uat/values.yaml +```yaml title="envs/uat/values.yaml" image: tag: 'v0.1.0' diff --git a/docs/deploy-applications/python-app.md b/docs/deploy-applications/python-app.md index 4b46ace35..48760cb2a 100644 --- a/docs/deploy-applications/python-app.md +++ b/docs/deploy-applications/python-app.md @@ -50,7 +50,7 @@ GlueOps relies on Docker images to deploy applications. We'll set up GitHub Acti - Copy and paste the following code into `ghcr.yaml`: -```yaml +```yaml title=".github/workflows/ghcr.yaml" name: GlueOps Action on: [push] @@ -71,7 +71,7 @@ GlueOps only supports container images published to the supported registry. ### Create Dockerfile Create a `Dockerfile` using the template below -``` +```Dockerfile title="Dockerfile" FROM httpd:2.4.57 COPY template/index.html /usr/local/apache2/htdocs/template/index.html @@ -110,8 +110,7 @@ Replace `GH_TOKEN` with your secret name. ::: -```yaml -# .github/workflows/prod-ci.yaml +```yaml title=".github/workflows/prod-ci.yaml" name: ArgoCD - Prod Tags CI @@ -138,8 +137,7 @@ In the `stage-ci.yaml` file add the following content: Replace `GH_TOKEN` with your secret name. ::: -```yaml -# .github/workflows/stage-ci.yaml +```yaml title=".github/workflows/stage-ci.yaml" name: ArgoCD - Staging Tags CI @@ -163,10 +161,9 @@ jobs: In the `uat-ci.yaml` file add the following content: -```yaml -# .github/workflows/uat-ci.yaml +```yaml title=".github/workflows/uat-ci.yaml" -name: ArgoCD - QA Tags CI +name: ArgoCD - UAT Tags CI on: release: @@ -223,8 +220,7 @@ Replace `venkata-tenant-test-1/python-app` with your organization and repository Create a file named `values.yaml` in the `envs/prod` folder and add the following content: -```yaml -# envs/prod/values.yaml +```yaml title="envs/prod/values.yaml" image: tag: 'v0.2.0' @@ -256,8 +252,7 @@ Replace the placeholders as follows: Create a file named `values.yaml` in the `envs/stage` folder and add the following content: -```yaml -# envs/stage/values.yaml +```yaml title="envs/stage/values.yaml" image: tag: 'latest' @@ -288,8 +283,7 @@ Replace the placeholders as follows: Create a file named `values.yaml` in the `envs/uat` folder and add the following content: -```yaml -# envs/uat/values.yaml +```yaml title="envs/uat/values.yaml" image: tag: 'v0.1.0' From 8dbee8c8ee8b7d2e500171bdd7ba67ae517b7afd Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Thu, 14 Sep 2023 06:28:43 +0000 Subject: [PATCH 02/20] fix: remove venkatamutyala.com and antoniostacos.com and only use antoniostacos.net --- docs/deploy-applications/docusaurs.md | 24 ++++++++++++------------ docs/deploy-applications/hello-world.md | 24 ++++++++++++------------ docs/deploy-applications/python-app.md | 24 ++++++++++++------------ 3 files changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/deploy-applications/docusaurs.md b/docs/deploy-applications/docusaurs.md index 3b72d2651..c1d5f6583 100644 --- a/docs/deploy-applications/docusaurs.md +++ b/docs/deploy-applications/docusaurs.md @@ -197,20 +197,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: docusarus-website-prod.nonprod.antoniostacos.com + - secretName: docusarus-website-prod.nonprod.antoniostacos.net hosts: - - docusarus-website-prod.nonprod.antoniostacos.com + - docusarus-website-prod.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: docusarus-website-prod.apps.nonprod.antoniostacos.onglueops.com - - hostname: docusarus-website-prod.nonprod.antoniostacos.com + - hostname: docusarus-website-prod.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `docusarus-website` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -228,20 +228,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: docusarus-website-stage.nonprod.antoniostacos.com + - secretName: docusarus-website-stage.nonprod.antoniostacos.net hosts: - - docusarus-website-stage.nonprod.antoniostacos.com + - docusarus-website-stage.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: docusarus-website-stage.apps.nonprod.antoniostacos.onglueops.com - - hostname: docusarus-website-stage.nonprod.antoniostacos.com + - hostname: docusarus-website-stage.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `docusarus-website` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -259,20 +259,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: docusarus-website-uat.nonprod.antoniostacos.com + - secretName: docusarus-website-uat.nonprod.antoniostacos.net hosts: - - docusarus-website-uat.nonprod.antoniostacos.com + - docusarus-website-uat.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: docusarus-website-uat.apps.nonprod.antoniostacos.onglueops.com - - hostname: docusarus-website-uat.nonprod.antoniostacos.com + - hostname: docusarus-website-uat.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `docusarus-website` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index d6c034be3..7a2fff452 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -212,20 +212,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: demo-app-1-prod.nonprod.antoniostacos.com + - secretName: demo-app-1-prod.nonprod.antoniostacos.net hosts: - - demo-app-1-prod.nonprod.antoniostacos.com + - demo-app-1-prod.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: demo-app-1-prod.apps.nonprod.antoniostacos.onglueops.com - - hostname: demo-app-1-prod.nonprod.antoniostacos.com + - hostname: demo-app-1-prod.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `demo-app-1` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -244,20 +244,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: demo-app-1-stage.nonprod.antoniostacos.com + - secretName: demo-app-1-stage.nonprod.antoniostacos.net hosts: - - demo-app-1-stage.nonprod.antoniostacos.com + - demo-app-1-stage.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: demo-app-1-stage.apps.nonprod.antoniostacos.onglueops.com - - hostname: demo-app-1-stage.nonprod.antoniostacos.com + - hostname: demo-app-1-stage.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `demo-app-1` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -276,20 +276,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: demo-app-1-uat.nonprod.antoniostacos.com + - secretName: demo-app-1-uat.nonprod.antoniostacos.net hosts: - - demo-app-1-uat.nonprod.antoniostacos.com + - demo-app-1-uat.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: demo-app-1-uat.apps.nonprod.antoniostacos.onglueops.com - - hostname: demo-app-1-uat.nonprod.antoniostacos.com + - hostname: demo-app-1-uat.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `demo-app-1` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: diff --git a/docs/deploy-applications/python-app.md b/docs/deploy-applications/python-app.md index 48760cb2a..d58e4bf57 100644 --- a/docs/deploy-applications/python-app.md +++ b/docs/deploy-applications/python-app.md @@ -231,20 +231,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: python-app-prod.nonprod.antoniostacos.com + - secretName: python-app-prod.nonprod.antoniostacos.net hosts: - - python-app-prod.nonprod.antoniostacos.com + - python-app-prod.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: python-app-prod.apps.nonprod.antoniostacos.onglueops.com - - hostname: python-app-prod.nonprod.antoniostacos.com + - hostname: python-app-prod.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `python-app` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -262,20 +262,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: python-app-stage.nonprod.antoniostacos.com + - secretName: python-app-stage.nonprod.antoniostacos.net hosts: - - python-app-stage.nonprod.antoniostacos.com + - python-app-stage.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: python-app-stage.apps.nonprod.antoniostacos.onglueops.com - - hostname: python-app-stage.nonprod.antoniostacos.com + - hostname: python-app-stage.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `python-app` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -293,20 +293,20 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: python-app-uat.nonprod.antoniostacos.com + - secretName: python-app-uat.nonprod.antoniostacos.net hosts: - - python-app-uat.nonprod.antoniostacos.com + - python-app-uat.nonprod.antoniostacos.net entries: - name: public hosts: - hostname: python-app-uat.apps.nonprod.antoniostacos.onglueops.com - - hostname: python-app-uat.nonprod.antoniostacos.com + - hostname: python-app-uat.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: - Replace `python-app` with your actual repository name. -- Replace `venkatamutyala.com` with your actual hosting name. +- Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: From df1bb11c4037e050f56342e09f7a101a1700378a Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Thu, 14 Sep 2023 06:29:59 +0000 Subject: [PATCH 03/20] fix: remove info around GH_TOKEN as it's already set by the platform administrator --- docs/deploy-applications/docusaurs.md | 12 +++--------- docs/deploy-applications/hello-world.md | 16 ++++------------ docs/deploy-applications/python-app.md | 12 +++--------- 3 files changed, 10 insertions(+), 30 deletions(-) diff --git a/docs/deploy-applications/docusaurs.md b/docs/deploy-applications/docusaurs.md index c1d5f6583..238c1878d 100644 --- a/docs/deploy-applications/docusaurs.md +++ b/docs/deploy-applications/docusaurs.md @@ -91,9 +91,7 @@ jobs: ENV: 'prod' CREATE_PR: true ``` -:::info -Replace `GH_TOKEN` with your secret name. -::: + ### Sample Configuration for `stage` Environment: @@ -119,9 +117,7 @@ jobs: ENV: 'stage' CREATE_PR: false ``` -:::info -Replace `GH_TOKEN` with your secret name. -::: + ### Sample Configuration for `uat` Environment: @@ -147,9 +143,7 @@ jobs: ENV: 'uat' CREATE_PR: true ``` -:::info -Replace `GH_TOKEN` with your secret name. -::: + ## Deploy the Application and Register Deployment Environments diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 7a2fff452..1968d1fb3 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -85,9 +85,7 @@ Each workflow file uses the `GlueOps/github-workflows/.github/workflows/argocd-t In the `prod-ci.yaml` file add the following content: -:::info -Replace `GH_TOKEN` with your secret name. -::: + ```yaml title=".github/workflows/prod-ci.yaml" @@ -107,9 +105,7 @@ jobs: ENV: 'prod' CREATE_PR: true ``` -:::info -Replace `GH_TOKEN` with your secret name. -::: + ### Sample Configuration for `stage` Environment: @@ -134,9 +130,7 @@ jobs: ENV: 'stage' CREATE_PR: false ``` -:::info -Replace `GH_TOKEN` with your secret name. -::: + ### Sample Configuration for `uat` Environment: @@ -161,9 +155,7 @@ jobs: CREATE_PR: true ``` -:::info -Replace `GH_TOKEN` with your secret name. -::: + ## Deploy the Application and Register Deployment Environments diff --git a/docs/deploy-applications/python-app.md b/docs/deploy-applications/python-app.md index d58e4bf57..50d8efe20 100644 --- a/docs/deploy-applications/python-app.md +++ b/docs/deploy-applications/python-app.md @@ -105,9 +105,7 @@ Each workflow file uses the `GlueOps/github-workflows/.github/workflows/argocd-t In the `prod-ci.yaml` file add the following content: -:::info -Replace `GH_TOKEN` with your secret name. -::: + ```yaml title=".github/workflows/prod-ci.yaml" @@ -133,9 +131,7 @@ jobs: In the `stage-ci.yaml` file add the following content: -:::info -Replace `GH_TOKEN` with your secret name. -::: + ```yaml title=".github/workflows/stage-ci.yaml" @@ -179,9 +175,7 @@ jobs: ENV: 'uat' CREATE_PR: true ``` -:::info -Replace `GH_TOKEN` with your secret name. -::: + ## Deploy the Application and Register Deployment Environments From 1217febd19635d126c273f8e9465cc6562678874 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Thu, 14 Sep 2023 07:18:02 +0000 Subject: [PATCH 04/20] fix: rename demo-app-1 to app-antoniostacos --- docs/deploy-applications/hello-world.md | 40 ++++++++++++------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 1968d1fb3..93ee7ae34 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -18,7 +18,7 @@ In this guide, we will walk you through the process of deploying a "Hello World" 2. Set up the necessary folders and files for your application. You can use the following folder structure: ``` -demo-app-1 +app-antoniostacos ├── .github │ └── workflows ├── README.md @@ -166,7 +166,7 @@ Next, deploy the app and register the specified environments (prod, stage, uat) 3. Your application directory should have the following structure: ``` -├── demo-app-1 +├── app-antoniostacos ├── base │ └── base-values.yaml ├── envs @@ -181,11 +181,11 @@ Next, deploy the app and register the specified environments (prod, stage, uat) ```yaml image: registry: ghcr.io - repository: venkata-tenant-test-1/demo-app-1 + repository: venkata-tenant-test-1/app-antoniostacos port: 80 ``` -Replace `venkata-tenant-test-1/demo-app-1` with your organization and repository name. +Replace `venkata-tenant-test-1/app-antoniostacos` with your organization and repository name. 5. Update the `values.yaml` file in the `prod`, `stage`, and `uat` folders accordingly. Change the image tag, hostnames, and other necessary details to match your application and GlueOps configuration. @@ -204,19 +204,19 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: demo-app-1-prod.nonprod.antoniostacos.net + - secretName: app-antoniostacos-prod.nonprod.antoniostacos.net hosts: - - demo-app-1-prod.nonprod.antoniostacos.net + - app-antoniostacos-prod.nonprod.antoniostacos.net entries: - name: public hosts: - - hostname: demo-app-1-prod.apps.nonprod.antoniostacos.onglueops.com - - hostname: demo-app-1-prod.nonprod.antoniostacos.net + - hostname: app-antoniostacos-prod.apps.nonprod.antoniostacos.onglueops.com + - hostname: app-antoniostacos-prod.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: -- Replace `demo-app-1` with your actual repository name. +- Replace `app-antoniostacos` with your actual repository name. - Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -236,19 +236,19 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: demo-app-1-stage.nonprod.antoniostacos.net + - secretName: app-antoniostacos-stage.nonprod.antoniostacos.net hosts: - - demo-app-1-stage.nonprod.antoniostacos.net + - app-antoniostacos-stage.nonprod.antoniostacos.net entries: - name: public hosts: - - hostname: demo-app-1-stage.apps.nonprod.antoniostacos.onglueops.com - - hostname: demo-app-1-stage.nonprod.antoniostacos.net + - hostname: app-antoniostacos-stage.apps.nonprod.antoniostacos.onglueops.com + - hostname: app-antoniostacos-stage.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: -- Replace `demo-app-1` with your actual repository name. +- Replace `app-antoniostacos` with your actual repository name. - Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -268,19 +268,19 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: demo-app-1-uat.nonprod.antoniostacos.net + - secretName: app-antoniostacos-uat.nonprod.antoniostacos.net hosts: - - demo-app-1-uat.nonprod.antoniostacos.net + - app-antoniostacos-uat.nonprod.antoniostacos.net entries: - name: public hosts: - - hostname: demo-app-1-uat.apps.nonprod.antoniostacos.onglueops.com - - hostname: demo-app-1-uat.nonprod.antoniostacos.net + - hostname: app-antoniostacos-uat.apps.nonprod.antoniostacos.onglueops.com + - hostname: app-antoniostacos-uat.nonprod.antoniostacos.net ``` :::important Replace the placeholders as follows: -- Replace `demo-app-1` with your actual repository name. +- Replace `app-antoniostacos` with your actual repository name. - Replace `antoniostacos.net` with your actual hosting name. - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: @@ -296,7 +296,7 @@ Go back to your application repository and edit the `index.html` file. Add a sim -

Hello World from demo-app-1

+

Hello World from app-antoniostacos

``` From 498d4162a1ea9d72a752d900e5dcbaf1f2138ef4 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Thu, 14 Sep 2023 07:18:57 +0000 Subject: [PATCH 05/20] fix: remove more instances of venkata --- docs/deploy-applications/docusaurs.md | 4 ++-- docs/deploy-applications/hello-world.md | 4 ++-- docs/deploy-applications/python-app.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/deploy-applications/docusaurs.md b/docs/deploy-applications/docusaurs.md index 238c1878d..f926f605e 100644 --- a/docs/deploy-applications/docusaurs.md +++ b/docs/deploy-applications/docusaurs.md @@ -169,11 +169,11 @@ Next, deploy the app and register the specified environments (prod, stage, uat) ```yaml image: registry: ghcr.io - repository: venkata-tenant-test-1/docusaurus-website + repository: antoniostacos/docusaurus-website port: 80 ``` -Replace `venkata-tenant-test-1/docusaurus-website` with your organization and repository name. +Replace `antoniostacos/docusaurus-website` with your organization and repository name. 5. Update the `values.yaml` file in the `prod`, `stage`, and `uat` folders accordingly. Change the image tag, hostnames, and other necessary details to match your application and GlueOps configuration. diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 93ee7ae34..30fd727cb 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -181,11 +181,11 @@ Next, deploy the app and register the specified environments (prod, stage, uat) ```yaml image: registry: ghcr.io - repository: venkata-tenant-test-1/app-antoniostacos + repository: antoniostacos/app-antoniostacos port: 80 ``` -Replace `venkata-tenant-test-1/app-antoniostacos` with your organization and repository name. +Replace `antoniostacos/app-antoniostacos` with your organization and repository name. 5. Update the `values.yaml` file in the `prod`, `stage`, and `uat` folders accordingly. Change the image tag, hostnames, and other necessary details to match your application and GlueOps configuration. diff --git a/docs/deploy-applications/python-app.md b/docs/deploy-applications/python-app.md index 50d8efe20..07f65af27 100644 --- a/docs/deploy-applications/python-app.md +++ b/docs/deploy-applications/python-app.md @@ -202,11 +202,11 @@ Next, deploy the app and register the specified environments (prod, stage, uat) ```yaml image: registry: ghcr.io - repository: venkata-tenant-test-1/python-app + repository: antoniostacos/python-app port: 80 ``` -Replace `venkata-tenant-test-1/python-app` with your organization and repository name. +Replace `antoniostacos/python-app` with your organization and repository name. 5. Update the `values.yaml` file in the `prod`, `stage`, and `uat` folders accordingly. Change the image tag, hostnames, and other necessary details to match your application and GlueOps configuration. @@ -311,7 +311,7 @@ Replace the placeholders as follows: Create a pull request (PR) to trigger the GitHub Action you set up for publishing the Docker image based on the latest code changes. The platform will automatically spin up a new environment and deploy the application. -Screenshot 2023-08-01 at 17 05 26 +Screenshot 2023-08-01 at 17 05 26 To view the app click on the preview URL. You can check the status of the deployment on Argos CD, which will show metrics, logs, and more. The QR code will also lead you to the preview URL. From 3b549a39e2215b47649ce42bc16acfed73ba2b99 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Thu, 14 Sep 2023 22:50:31 +0000 Subject: [PATCH 06/20] cleanup and and update all workflows --- docs/deploy-applications/hello-world.md | 120 ++++++++++++------------ 1 file changed, 60 insertions(+), 60 deletions(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 30fd727cb..32a3d7e7a 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -9,20 +9,25 @@ type: tutorial # Deploy a "Hello World" Application -In this guide, we will walk you through the process of deploying a "Hello World" application onto the GlueOps platform. We'll start from scratch and cover each step in detail to ensure you have a smooth deployment experience. +In this guide, we will walk you through the process of deploying a "Hello World" application onto the GlueOps platform. We'll start from scratch and cover each step in detail to ensure you have a smooth deployment experience. You may see references to `antoniostacos`, this name is for demo purposes only and can be replaced with your own company name. ## Create a New Repository and set up your application folder -1. Create a new repository for your application within your organization. +1. Create a new repository called your application called `app-antoniostacos` within [your organization](https://github.com/new) -2. Set up the necessary folders and files for your application. You can use the following folder structure: +The following is what you can expect your repository to look like by the end of the tutorial: ``` app-antoniostacos +├── Dockerfile ├── .github │ └── workflows +│ ├── ghcr.yaml +│ ├── prod-cd.yaml +│ ├── qa-cd.yaml +│ └── stage-cd.yaml +├── index.html ├── README.md -└── index.html ``` ## Set Up GitHub Actions for Docker Image Publishing @@ -46,17 +51,16 @@ jobs: uses: GlueOps/github-actions-build-push-containers@main ``` -:::info -GlueOps only supports container images published to the supported registry. -::: - ### Create Dockerfile Create a `Dockerfile` using the template below ```Dockerfile title="Dockerfile" FROM httpd:2.4.57 -COPY index.html /usr/local/apache2/htdocs/index.html +COPY ./index.html /usr/local/apache2/htdocs/ + +CMD [ "bash", "-c", "httpd-foreground" ] + ``` :::info Change `index.html` to the correct path of your index file. @@ -64,15 +68,15 @@ Change `index.html` to the correct path of your index file. ## Configure GitHub Workflows for Each Environment -In the `.github/workflows` directory of your application repository, we will add GitHub Actions workflow files for our environment: `prod-ci.yaml`, `stage-ci.yaml`, and `uat-ci.yaml`. +In the `.github/workflows` directory of your application repository, we will add GitHub Actions workflow files for our environment: `prod-cd.yaml`, `stage-cd.yaml`, and `qa-cd.yaml`. ``` . ├── .github │ └── workflows │ ├── ghcr.yaml -│ ├── prod-ci.yaml -│ ├── stage-ci.yaml -│ └── uat-ci.yaml +│ ├── prod-cd.yaml +│ ├── stage-cd.yaml +│ └── qa-cd.yaml ├── Dockerfile ├── README.md └── index.html @@ -83,13 +87,12 @@ Each workflow file uses the `GlueOps/github-workflows/.github/workflows/argocd-t ### Sample Configuration for `prod` Environment: -In the `prod-ci.yaml` file add the following content: - +In the `prod-cd.yaml` file add the following content: -```yaml title=".github/workflows/prod-ci.yaml" -name: ArgoCD - Prod Tags CI +```yaml title=".github/workflows/prod-cd.yaml" +name: prod CD on: release: @@ -97,69 +100,66 @@ on: - created jobs: update-tags: - uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@main - secrets: - GH_TOKEN: ${{ secrets.GH_TOKEN }} + uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@feat/adding-glueops-github-token-variable-name + secrets: inherit with: - STACK_REPO: 'deployment-configurations' ENV: 'prod' CREATE_PR: true + ``` ### Sample Configuration for `stage` Environment: -In the `stage-ci.yaml` file add the following content: - -```yaml title=".github/workflows/stage-ci.yaml" +In the `stage-cd.yaml` file add the following content: -name: ArgoCD - Staging Tags CI +```yaml title=".github/workflows/stage-cd.yaml" +name: stage CD on: - pull_request: + release: types: - - closed + - created jobs: update-tags: - uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@main - if: github.event.pull_request.merged == true - secrets: - GH_TOKEN: ${{ secrets.GH_TOKEN }} + uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@feat/adding-glueops-github-token-variable-name + secrets: inherit with: - STACK_REPO: 'deployment-configurations' ENV: 'stage' - CREATE_PR: false + CREATE_PR: true + ``` -### Sample Configuration for `uat` Environment: +### Sample Configuration for `qa` Environment: -In the `uat-ci.yaml` file add the following content: +In the `qa-cd.yaml` file add the following content: -```yaml title=".github/workflows/uat-ci.yaml" +```yaml title=".github/workflows/qa-cd.yaml" -name: ArgoCD - UAT Tags CI +name: qa CD on: - release: + pull_request: types: - - created + - closed + jobs: update-tags: - uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@main - secrets: - GH_TOKEN: ${{ secrets.GH_TOKEN }} + uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@feat/adding-glueops-github-token-variable-name + if: github.event.pull_request.merged == true + secrets: inherit with: - STACK_REPO: 'deployment-configurations' - ENV: 'uat' - CREATE_PR: true + ENV: 'qa' + CREATE_PR: false + ``` ## Deploy the Application and Register Deployment Environments -Next, deploy the app and register the specified environments (prod, stage, uat) inside the GlueOps Argo CD. Here's what you need to do: +Next, deploy the app and register the specified environments (prod, stage, qa) inside the GlueOps Argo CD. Here's what you need to do: 1. Go to the [deployment-configurations](https://github.com/GlueOps/deployment-configurations) repository. 2. Inside the `app` directory, duplicate one of the example demo apps and rename it to your application's name. @@ -173,7 +173,7 @@ Next, deploy the app and register the specified environments (prod, stage, uat) │ ├── previews │ ├── prod │ ├── stage -│ └── uat +│ └── qa ``` 4. In the `base-values.yaml` file inside the `base` directory, update the information to fit your application. For example, the `base-values.yaml` might look like this: @@ -187,7 +187,7 @@ image: Replace `antoniostacos/app-antoniostacos` with your organization and repository name. -5. Update the `values.yaml` file in the `prod`, `stage`, and `uat` folders accordingly. Change the image tag, hostnames, and other necessary details to match your application and GlueOps configuration. +5. Update the `values.yaml` file in the `prod`, `stage`, and `qa` folders accordingly. Change the image tag, hostnames, and other necessary details to match your application and GlueOps configuration. ### `prod` Environment Sample Configuration: @@ -253,11 +253,11 @@ Replace the placeholders as follows: - Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. ::: -### `uat` Environment Sample Configuration: +### `qa` Environment Sample Configuration: -Create a file named `values.yaml` in the `envs/uat` folder and add the following content: +Create a file named `values.yaml` in the `envs/qa` folder and add the following content: -```yaml title="envs/uat/values.yaml" +```yaml title="envs/qa/values.yaml" image: tag: 'v0.1.0' @@ -268,14 +268,14 @@ ingress: annotations: cert-manager.io/cluster-issuer: letsencrypt tls: - - secretName: app-antoniostacos-uat.nonprod.antoniostacos.net + - secretName: app-antoniostacos-qa.nonprod.antoniostacos.net hosts: - - app-antoniostacos-uat.nonprod.antoniostacos.net + - app-antoniostacos-qa.nonprod.antoniostacos.net entries: - name: public hosts: - - hostname: app-antoniostacos-uat.apps.nonprod.antoniostacos.onglueops.com - - hostname: app-antoniostacos-uat.nonprod.antoniostacos.net + - hostname: app-antoniostacos-qa.apps.nonprod.antoniostacos.onglueops.com + - hostname: app-antoniostacos-qa.nonprod.antoniostacos.net ``` :::important @@ -322,17 +322,17 @@ The staging enviroment is automatically deployed, to check your application: 2. In the `values.yaml` file located in the `stage` folder, you will find the configuration for the staging environment. Check the `hostname` entry to check your application deployed to the staging environment. -### Deploying to `prod` and `uat` Environments +### Deploying to `prod` and `qa` Environments -1. To deploy your application to the prod and UAT environments, you need to create a release in your application's repository (e.g., v0.1.0, v1.0.0, etc.). This release will mark the specific version of your application that you want to deploy to these environments. +1. To deploy your application to the prod and qa environments, you need to create a release in your application's repository (e.g., v0.1.0, v1.0.0, etc.). This release will mark the specific version of your application that you want to deploy to these environments. -2. Upon creating the release, GitHub will automatically generate pull requests into the deployment-configurations repository. These pull requests will contain the necessary changes for the prod and UAT environments, located in the `envs/prod` and `envs/uat` directories, respectively. +2. Upon creating the release, GitHub will automatically generate pull requests into the deployment-configurations repository. These pull requests will contain the necessary changes for the prod and qa environments, located in the `envs/prod` and `envs/qa` directories, respectively. Screenshot 2023-07-28 at 13 19 12 -3. Review and merge the pull requests in the deployment-configurations repository. This will trigger the deployment process to both the `prod` and `uat` environments. +3. Review and merge the pull requests in the deployment-configurations repository. This will trigger the deployment process to both the `prod` and `qa` environments. -5. Once the deployment process is completed, your application will be accessible in both the `prod` and `uat` environments hostnames +5. Once the deployment process is completed, your application will be accessible in both the `prod` and `qa` environments hostnames ## Conclusion From 854b04341b694126cae8eb25a8e692280ba6b1cd Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 08:10:03 +0000 Subject: [PATCH 07/20] wip --- docs/deploy-applications/hello-world.md | 476 ++++++++++++------------ 1 file changed, 248 insertions(+), 228 deletions(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 32a3d7e7a..46dfa2bb4 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -4,336 +4,356 @@ title: Deploy a "Hello World" Application type: tutorial --- +# Deploy a "Hello World" Application +In this guide, we will walk you through the process of deploying a "Hello World" application onto the GlueOps platform. We'll start from scratch and cover each step in detail to ensure you have a smooth deployment experience. You may see references to `antoniostacos`, this name is for demo purposes only and can be replaced with your own company name(s) and/or app name(s). +By the end of this guide you will have deployed your own QA deployment of `antoniostacos` on the GlueOps platform. -# Deploy a "Hello World" Application +## Create a New Repository -In this guide, we will walk you through the process of deploying a "Hello World" application onto the GlueOps platform. We'll start from scratch and cover each step in detail to ensure you have a smooth deployment experience. You may see references to `antoniostacos`, this name is for demo purposes only and can be replaced with your own company name. +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; -## Create a New Repository and set up your application folder +:::note -1. Create a new repository called your application called `app-antoniostacos` within [your organization](https://github.com/new) +This is the file structure that you can expect your repository to look like by the end of the tutorial. As we go through each step we will highlight the files/folders you will be working on with a `<` symbol -The following is what you can expect your repository to look like by the end of the tutorial: + + ``` -app-antoniostacos +app-antoniostacos < ├── Dockerfile ├── .github │ └── workflows │ ├── ghcr.yaml -│ ├── prod-cd.yaml -│ ├── qa-cd.yaml -│ └── stage-cd.yaml -├── index.html +│ └── qa-cd.yaml +├── app.js ├── README.md ``` -## Set Up GitHub Actions for Docker Image Publishing - -Now, let's configure GitHub Actions to automatically publish a Docker image of your application. This will allow the GlueOps platform to use the latest version of your app. As a happy path, we have provided this [Custom Action to push Docker images to GitHub Container Registry](https://github.com/marketplace/actions/build-docker-image-and-push-to-ghcr). Here's how you can set it up: + + -1. In your newly created repository, navigate to the `.github/workflows` folder. -2. Create a new file named `ghcr.yaml` in the `workflows` folder. -3. Copy and paste the following code into `ghcr.yaml`: - -```yaml title=".github/workflows/ghcr.yaml" -name: GlueOps Action - -on: [push] - -jobs: - build_tag_push_to_ghcr: - runs-on: ubuntu-latest - steps: - - name: Build, Tag and Push Docker Image to GHCR - uses: GlueOps/github-actions-build-push-containers@main ``` - -### Create Dockerfile -Create a `Dockerfile` using the template below - -```Dockerfile title="Dockerfile" -FROM httpd:2.4.57 - -COPY ./index.html /usr/local/apache2/htdocs/ - -CMD [ "bash", "-c", "httpd-foreground" ] - +app-antoniostacos < +├── Dockerfile +├── .github +│ └── workflows +│ ├── ghcr.yaml +│ └── qa-cd.yaml +├── app.py +├── README.md ``` -:::info -Change `index.html` to the correct path of your index file. -::: - -## Configure GitHub Workflows for Each Environment + + -In the `.github/workflows` directory of your application repository, we will add GitHub Actions workflow files for our environment: `prod-cd.yaml`, `stage-cd.yaml`, and `qa-cd.yaml`. ``` -. +app-antoniostacos < +├── Dockerfile ├── .github │ └── workflows │ ├── ghcr.yaml -│ ├── prod-cd.yaml -│ ├── stage-cd.yaml │ └── qa-cd.yaml -├── Dockerfile +├── app.rb ├── README.md -└── index.html ``` + + -Each workflow file uses the `GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml` action to notify Argo CD about the new image tags and initiate the deployment process. +::: +Create a [new repository](https://github.com/new) with your application name, such as: `app-antoniostacos`. -### Sample Configuration for `prod` Environment: +## Add your application code and Dockerfile -In the `prod-cd.yaml` file add the following content: +:::info +Marked below are the files we will be adding: + + +``` +app-antoniostacos +├── Dockerfile < +├── .github +│ └── workflows +│ ├── ghcr.yaml +│ └── qa-cd.yaml +├── app.js < +├── README.md +``` -```yaml title=".github/workflows/prod-cd.yaml" -name: prod CD + + -on: - release: - types: - - created -jobs: - update-tags: - uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@feat/adding-glueops-github-token-variable-name - secrets: inherit - with: - ENV: 'prod' - CREATE_PR: true +``` +app-antoniostacos +├── Dockerfile < +├── .github +│ └── workflows +│ ├── ghcr.yaml +│ └── qa-cd.yaml +├── app.py < +├── README.md +``` + + ``` +app-antoniostacos +├── Dockerfile < +├── .github +│ └── workflows +│ ├── ghcr.yaml +│ └── qa-cd.yaml +├── app.rb < +├── README.md +``` + + +::: +### Application Code -### Sample Configuration for `stage` Environment: +Within your repo create the file that contains your code: -In the `stage-cd.yaml` file add the following content: + + -```yaml title=".github/workflows/stage-cd.yaml" -name: stage CD +```js title="app-antoniostacos/app.js" +const express = require('express'); +const app = express(); -on: - release: - types: - - created -jobs: - update-tags: - uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@feat/adding-glueops-github-token-variable-name - secrets: inherit - with: - ENV: 'stage' - CREATE_PR: true +app.get('/', (req, res) => { + const greeting = process.env.GREETING_MESSAGE || 'Hello, World!'; + res.send(greeting); +}); +app.listen(8080, () => { + console.log('Server running on http://localhost:8080'); +}); ``` + + -### Sample Configuration for `qa` Environment: +```py title="app-antoniostacos/app.py" +import os +from flask import Flask +app = Flask(__name__) -In the `qa-cd.yaml` file add the following content: +@app.route('/') +def hello_world(): + greeting = os.environ.get('GREETING_MESSAGE', 'Hello, World!') + return greeting -```yaml title=".github/workflows/qa-cd.yaml" +if __name__ == '__main__': + app.run(host='0.0.0.0', port=8080) +``` + + -name: qa CD +```ruby title="app-antoniostacos/app.rb" +require 'sinatra' -on: - pull_request: - types: - - closed - -jobs: - update-tags: - uses: GlueOps/github-workflows/.github/workflows/argocd-tags-ci.yml@feat/adding-glueops-github-token-variable-name - if: github.event.pull_request.merged == true - secrets: inherit - with: - ENV: 'qa' - CREATE_PR: false +set :bind, '0.0.0.0' # This binds the server to all network interfaces. +set :port, 8080 # This sets the default port to 8080. +get '/' do + greeting = ENV['GREETING_MESSAGE'] || 'Hello, World!' + greeting +end ``` + + +Save the file and commit your changes. -## Deploy the Application and Register Deployment Environments +### Dockerfile -Next, deploy the app and register the specified environments (prod, stage, qa) inside the GlueOps Argo CD. Here's what you need to do: +Next, create a `Dockerfile` using the template below within your application repository -1. Go to the [deployment-configurations](https://github.com/GlueOps/deployment-configurations) repository. -2. Inside the `app` directory, duplicate one of the example demo apps and rename it to your application's name. -3. Your application directory should have the following structure: + + -``` -├── app-antoniostacos -├── base -│ └── base-values.yaml -├── envs -│ ├── previews -│ ├── prod -│ ├── stage -│ └── qa -``` +```docker title="app-antoniostacos/Dockerfile" +FROM node:18-alpine -4. In the `base-values.yaml` file inside the `base` directory, update the information to fit your application. For example, the `base-values.yaml` might look like this: +WORKDIR /app -```yaml -image: - registry: ghcr.io - repository: antoniostacos/app-antoniostacos - port: 80 -``` +COPY . /app -Replace `antoniostacos/app-antoniostacos` with your organization and repository name. +RUN npm install express -5. Update the `values.yaml` file in the `prod`, `stage`, and `qa` folders accordingly. Change the image tag, hostnames, and other necessary details to match your application and GlueOps configuration. +CMD ["node", "app.js"] +``` + + -### `prod` Environment Sample Configuration: +```docker title="app-antoniostacos/Dockerfile" +FROM python:3-alpine -Create a file named `values.yaml` in the `envs/prod` folder and add the following content: +WORKDIR /app -```yaml title="envs/prod/values.yaml" +COPY . /app -image: - tag: 'v0.2.0' +RUN pip install --no-cache-dir Flask -ingress: - enabled: true - ingressClassName: public - annotations: - cert-manager.io/cluster-issuer: letsencrypt - tls: - - secretName: app-antoniostacos-prod.nonprod.antoniostacos.net - hosts: - - app-antoniostacos-prod.nonprod.antoniostacos.net - entries: - - name: public - hosts: - - hostname: app-antoniostacos-prod.apps.nonprod.antoniostacos.onglueops.com - - hostname: app-antoniostacos-prod.nonprod.antoniostacos.net +CMD ["python", "app.py"] ``` + + -:::important -Replace the placeholders as follows: -- Replace `app-antoniostacos` with your actual repository name. -- Replace `antoniostacos.net` with your actual hosting name. -- Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. -::: +```docker title="app-antoniostacos/Dockerfile" +FROM ruby:3-alpine -### `stage` Environment Sample Configuration: +WORKDIR /app -Create a file named `values.yaml` in the `envs/stage` folder and add the following content: +COPY . /app -```yaml title="envs/stage/values.yaml" +RUN gem install sinatra webrick -image: - tag: 'latest' - -ingress: - enabled: true - ingressClassName: public - annotations: - cert-manager.io/cluster-issuer: letsencrypt - tls: - - secretName: app-antoniostacos-stage.nonprod.antoniostacos.net - hosts: - - app-antoniostacos-stage.nonprod.antoniostacos.net - entries: - - name: public - hosts: - - hostname: app-antoniostacos-stage.apps.nonprod.antoniostacos.onglueops.com - - hostname: app-antoniostacos-stage.nonprod.antoniostacos.net +CMD ["ruby", "app.rb"] ``` + + -:::important -Replace the placeholders as follows: -- Replace `app-antoniostacos` with your actual repository name. -- Replace `antoniostacos.net` with your actual hosting name. -- Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. -::: +Save the file and commit your changes. -### `qa` Environment Sample Configuration: +## Add CI to publish a Docker image to GitHub Container Registry +:::info +Marked below are the files we will be adding: -Create a file named `values.yaml` in the `envs/qa` folder and add the following content: + + -```yaml title="envs/qa/values.yaml" +``` +app-antoniostacos +├── Dockerfile +├── .github +│ └── workflows +│ ├── ghcr.yaml < +│ └── qa-cd.yaml +├── app.js +├── README.md +``` -image: - tag: 'v0.1.0' + + -ingress: - enabled: true - ingressClassName: public - annotations: - cert-manager.io/cluster-issuer: letsencrypt - tls: - - secretName: app-antoniostacos-qa.nonprod.antoniostacos.net - hosts: - - app-antoniostacos-qa.nonprod.antoniostacos.net - entries: - - name: public - hosts: - - hostname: app-antoniostacos-qa.apps.nonprod.antoniostacos.onglueops.com - - hostname: app-antoniostacos-qa.nonprod.antoniostacos.net ``` +app-antoniostacos +├── Dockerfile +├── .github +│ └── workflows +│ ├── ghcr.yaml < +│ └── qa-cd.yaml +├── app.py +├── README.md +``` + + -:::important -Replace the placeholders as follows: -- Replace `app-antoniostacos` with your actual repository name. -- Replace `antoniostacos.net` with your actual hosting name. -- Replace `nonprod.antoniostacos.onglueops.com` with the name of your GlueOps cluster provided by GlueOps. +``` +app-antoniostacos +├── Dockerfile +├── .github +│ └── workflows +│ ├── ghcr.yaml < +│ └── qa-cd.yaml +├── app.rb +├── README.md +``` + + ::: -6. Save and commit your changes to the deployment repository. +Creating this `YAML` will add a GitHub Action that will automatically publish a Docker image of your application to the GitHub Container Registry (GHCR.io). This will allow the GlueOps platform to use the latest version of your app in it's deployments. As a happy path, we have provided this [custom action to push Docker images to your GitHub Container Registry (GHCR.io)](https://github.com/marketplace/actions/build-docker-image-and-push-to-ghcr). -## Add a Simple HTML "Hello World" Code +To use it, Simply create the file below -Go back to your application repository and edit the `index.html` file. Add a simple "Hello World" HTML code, like this: +```yaml title="app-antoniostacos/.github/workflows/ghcr.yaml" +name: Publish to GHCR.io + +on: [push] -```html - - - - -

Hello World from app-antoniostacos

- - +jobs: + build_tag_push_to_ghcr: + runs-on: ubuntu-latest + steps: + - name: Build, Tag and Push Docker Image to GHCR + uses: GlueOps/github-actions-build-push-containers@main ``` -Save the file and commit your changes. - -## Trigger GitHub Actions to Publish the Docker Image - -Create a pull request (PR) to trigger the GitHub Action you set up for publishing the Docker image based on the latest code changes. The platform will automatically spin up a new environment and deploy the application. +Save the file and commit your changes and push up your changess. -To view the app click on the preview URL. You can check the status of the deployment on Argos CD, which will show metrics, logs, and more. The QR code will also lead you to the preview URL. +:::note -Screenshot 2023-07-28 at 12 53 14 +Once you push up your changes visit your github repository actions page. You can find it at: https://github.com///actions. You should see the status of `Publish to GHCR.io` within this page. And if you see nothing but "Green" circles then everything completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact(s) published to: https://github.com///packages +::: -## Deploying to Environments +## Let's deploy your app! -### Check application deployed to your Staging Enviroment +:::info +Below is an example of the structure we will be adding to your deployment configurations repository -The staging enviroment is automatically deployed, to check your application: +``` +├── apps +│ └── app-antoniostacos +│ └── envs +│ └── qa +│ └── values.yaml +``` -1. Navigate to the `envs/stage` directory within the [deployment-configurations](https://github.com/GlueOps/deployment-configurations) repository. +::: -2. In the `values.yaml` file located in the `stage` folder, you will find the configuration for the staging environment. Check the `hostname` entry to check your application deployed to the staging environment. +We are almost at the end, let's get your app deployed so your QA team can check it out! Just create this file below: -### Deploying to `prod` and `qa` Environments -1. To deploy your application to the prod and qa environments, you need to create a release in your application's repository (e.g., v0.1.0, v1.0.0, etc.). This release will mark the specific version of your application that you want to deploy to these environments. +```yaml title="apps/app-antoniostacos/envs/qa/values.yaml" +# configurations unique to the production deployment of this application +image: + repository: 'antoniostacos/app-antoniostacos' + registry: ghcr.io + pullPolicy: Always + port: 8080 + tag: main +service: + enabled: true +deployment: + replicas: 1 + enabled: true + imagePullPolicy: Always + imagePullSecrets: regcred + resources: + requests: + cpu: 100m + memory: 128Mi -2. Upon creating the release, GitHub will automatically generate pull requests into the deployment-configurations repository. These pull requests will contain the necessary changes for the prod and qa environments, located in the `envs/prod` and `envs/qa` directories, respectively. +ingress: + enabled: true + ingressClassName: public + entries: + - name: public + hosts: + - hostname: 'app-antoniostacos-qa.apps.nonprod.antoniostacos.onglueops.com' +``` -Screenshot 2023-07-28 at 13 19 12 +:::danger +You must replace the placeholders as follows: +- Replace `antoniostacos/app-antoniostacos` with your actual container repository owner/name. In this case, we are using GitHub container registry so `antoniostacos` is the github organization and `app-antoniostacos` is the name of the repository. +- Replace `nonprod.antoniostacos.onglueops.com` with the captain domain provided by GlueOps +::: -3. Review and merge the pull requests in the deployment-configurations repository. This will trigger the deployment process to both the `prod` and `qa` environments. +Save and commit your changes to the deployment configurations repository and push up the changes. Within a minute you should be able to view your site at: https://app-antoniostacos-qa.apps.nonprod.antoniostacos.onglueops.com -5. Once the deployment process is completed, your application will be accessible in both the `prod` and `qa` environments hostnames +:::note -## Conclusion +The URL above will require modifications to actually resolve to your app. -Congratulations! You have successfully deployed a basic "Hello World" application onto the GlueOps platform. +Ex. https://``-``.apps.`` +::: From 4ab2314c5c1d648e6ae7fe49f4c7476f81787fba Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 08:18:03 +0000 Subject: [PATCH 08/20] fix: remove comment --- docs/deploy-applications/hello-world.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 46dfa2bb4..5c0b22189 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -315,7 +315,6 @@ We are almost at the end, let's get your app deployed so your QA team can check ```yaml title="apps/app-antoniostacos/envs/qa/values.yaml" -# configurations unique to the production deployment of this application image: repository: 'antoniostacos/app-antoniostacos' registry: ghcr.io From c71457b4368e657637381d6403493481fd77fb0c Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:28:23 +0000 Subject: [PATCH 09/20] cleanup placeholders --- docs/deploy-applications/hello-world.md | 39 ++++++++++--------------- 1 file changed, 16 insertions(+), 23 deletions(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 5c0b22189..8a84b64b0 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -122,7 +122,7 @@ Within your repo create the file that contains your code: -```js title="app-antoniostacos/app.js" +```js title="/app.js" const express = require('express'); const app = express(); @@ -139,7 +139,7 @@ app.listen(8080, () => { -```py title="app-antoniostacos/app.py" +```py title="/app.py" import os from flask import Flask app = Flask(__name__) @@ -155,7 +155,7 @@ if __name__ == '__main__': -```ruby title="app-antoniostacos/app.rb" +```ruby title="/app.rb" require 'sinatra' set :bind, '0.0.0.0' # This binds the server to all network interfaces. @@ -179,7 +179,7 @@ Next, create a `Dockerfile` using the template below within your application rep -```docker title="app-antoniostacos/Dockerfile" +```docker title="/Dockerfile" FROM node:18-alpine WORKDIR /app @@ -193,7 +193,7 @@ CMD ["node", "app.js"] -```docker title="app-antoniostacos/Dockerfile" +```docker title="/Dockerfile" FROM python:3-alpine WORKDIR /app @@ -207,7 +207,7 @@ CMD ["python", "app.py"] -```docker title="app-antoniostacos/Dockerfile" +```docker title="/Dockerfile" FROM ruby:3-alpine WORKDIR /app @@ -275,7 +275,7 @@ Creating this `YAML` will add a GitHub Action that will automatically publish a To use it, Simply create the file below -```yaml title="app-antoniostacos/.github/workflows/ghcr.yaml" +```yaml title="/.github/workflows/ghcr.yaml" name: Publish to GHCR.io on: [push] @@ -292,8 +292,7 @@ Save the file and commit your changes and push up your changess. :::note -Once you push up your changes visit your github repository actions page. You can find it at: https://github.com///actions. You should see the status of `Publish to GHCR.io` within this page. And if you see nothing but "Green" circles then everything completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact(s) published to: https://github.com///packages - +Once you push up your changes visit your github repository actions page to view the status. You can find it at: https://github.com///actions. If you see nothing but "Green" circles then everything completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact(s) published to: https://github.com///packages. ::: ## Let's deploy your app! @@ -314,9 +313,9 @@ Below is an example of the structure we will be adding to your deployment config We are almost at the end, let's get your app deployed so your QA team can check it out! Just create this file below: -```yaml title="apps/app-antoniostacos/envs/qa/values.yaml" +```yaml title="apps//envs/qa/values.yaml" image: - repository: 'antoniostacos/app-antoniostacos' + repository: '/' registry: ghcr.io pullPolicy: Always port: 8080 @@ -339,20 +338,14 @@ ingress: entries: - name: public hosts: - - hostname: 'app-antoniostacos-qa.apps.nonprod.antoniostacos.onglueops.com' + - hostname: '-qa.apps.' ``` -:::danger +:::tip You must replace the placeholders as follows: -- Replace `antoniostacos/app-antoniostacos` with your actual container repository owner/name. In this case, we are using GitHub container registry so `antoniostacos` is the github organization and `app-antoniostacos` is the name of the repository. -- Replace `nonprod.antoniostacos.onglueops.com` with the captain domain provided by GlueOps +- Replace `` and `` with your github organization name and your repository name. +- Replace `` with your own friendly app name. +- Replace `` with your captain domain. This is environment specific and provided by your Platform Administrators. ::: -Save and commit your changes to the deployment configurations repository and push up the changes. Within a minute you should be able to view your site at: https://app-antoniostacos-qa.apps.nonprod.antoniostacos.onglueops.com - -:::note - -The URL above will require modifications to actually resolve to your app. - -Ex. https://``-``.apps.`` -::: +Save and commit your changes to the deployment configurations repository and push up the changes. From 800cbcc3e5b151226eca021fa5f83ae55910012a Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:28:59 +0000 Subject: [PATCH 10/20] cleanup --- docs/deploy-applications/hello-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 8a84b64b0..7e2be610b 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -290,7 +290,7 @@ jobs: Save the file and commit your changes and push up your changess. -:::note +:::tip Once you push up your changes visit your github repository actions page to view the status. You can find it at: https://github.com///actions. If you see nothing but "Green" circles then everything completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact(s) published to: https://github.com///packages. ::: From 7535749c92d089b795a7ad0c4474f54b610e8776 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:32:09 +0000 Subject: [PATCH 11/20] fix formatting --- docs/deploy-applications/hello-world.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 7e2be610b..4fa372776 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -310,8 +310,9 @@ Below is an example of the structure we will be adding to your deployment config ::: -We are almost at the end, let's get your app deployed so your QA team can check it out! Just create this file below: +We are almost at the end, let's get your app deployed so your QA team can check it out! +Within your deployment configs repo just create this file: ```yaml title="apps//envs/qa/values.yaml" image: From 0cfc30c0ddd6c6b257e2b2f6ba7a4c785f425d32 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:33:27 +0000 Subject: [PATCH 12/20] fixes --- docs/deploy-applications/hello-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 4fa372776..f2945b8b0 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -298,7 +298,7 @@ Once you push up your changes visit your github repository actions page to view ## Let's deploy your app! :::info -Below is an example of the structure we will be adding to your deployment configurations repository +Below is an example of the structure we will be adding to your deployment configurations repository. The exact location of this repository will be provided to your by a Platform Administrator. ``` ├── apps From c6c8489d865a0969ba861a763262c6ac3c295e80 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:34:24 +0000 Subject: [PATCH 13/20] cleanup --- docs/deploy-applications/hello-world.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index f2945b8b0..b4a50841d 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -298,7 +298,7 @@ Once you push up your changes visit your github repository actions page to view ## Let's deploy your app! :::info -Below is an example of the structure we will be adding to your deployment configurations repository. The exact location of this repository will be provided to your by a Platform Administrator. +Below is an example of the structure we will be adding to your "deployment configurations" repository. The exact name and location of this repository will be provided to your by a Platform Administrator. ``` ├── apps @@ -312,7 +312,7 @@ Below is an example of the structure we will be adding to your deployment config We are almost at the end, let's get your app deployed so your QA team can check it out! -Within your deployment configs repo just create this file: +Within your "deployment configurations" repository just create this file: ```yaml title="apps//envs/qa/values.yaml" image: From 10fe2b4be39adc33bcf305c70fc77cc89e576da2 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:35:38 +0000 Subject: [PATCH 14/20] fixes --- docs/deploy-applications/hello-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index b4a50841d..42e38484d 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -344,7 +344,7 @@ ingress: :::tip You must replace the placeholders as follows: -- Replace `` and `` with your github organization name and your repository name. +- Replace `` and `` with your github organization name and your application repository name. - Replace `` with your own friendly app name. - Replace `` with your captain domain. This is environment specific and provided by your Platform Administrators. ::: From 373b5fda0cf77b25698cecb28c79d33ceb75b4a5 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:37:31 +0000 Subject: [PATCH 15/20] cleanup --- docs/deploy-applications/hello-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 42e38484d..1aba29314 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -349,4 +349,4 @@ You must replace the placeholders as follows: - Replace `` with your captain domain. This is environment specific and provided by your Platform Administrators. ::: -Save and commit your changes to the deployment configurations repository and push up the changes. +Save and commit your changes to the deployment configurations repository and push up the changes. Within a minute you should see your app at: https://-qa.apps. From 6837a5ae90452e0ac070fe8e9f46da5cef76f2e8 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sat, 16 Sep 2023 23:44:10 +0000 Subject: [PATCH 16/20] fix spelling --- docs/deploy-applications/hello-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 1aba29314..3e8d15a5a 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -288,7 +288,7 @@ jobs: uses: GlueOps/github-actions-build-push-containers@main ``` -Save the file and commit your changes and push up your changess. +Save the file and commit your changes and push up your changes. :::tip From 01934b4a00524b6a37e85d96d89adb3351067dfe Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sun, 17 Sep 2023 00:02:19 +0000 Subject: [PATCH 17/20] cleanup --- docs/deploy-applications/hello-world.md | 36 +++++++++++++------------ 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 3e8d15a5a..c591063b4 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -6,9 +6,9 @@ type: tutorial # Deploy a "Hello World" Application -In this guide, we will walk you through the process of deploying a "Hello World" application onto the GlueOps platform. We'll start from scratch and cover each step in detail to ensure you have a smooth deployment experience. You may see references to `antoniostacos`, this name is for demo purposes only and can be replaced with your own company name(s) and/or app name(s). +In this guide, we will walk you through the process of deploying a "Hello World" application onto the GlueOps platform. We'll start from scratch and cover each step in detail to ensure you have a smooth deployment experience. You may see references to `antoniostacos`, this name is for demo purposes only and can be replaced with your actual project or company name where appropriate. -By the end of this guide you will have deployed your own QA deployment of `antoniostacos` on the GlueOps platform. +By the end of this guide, you will have deployed your antoniostacos application in a QA environment on the GlueOps platform. ## Create a New Repository @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem'; :::note -This is the file structure that you can expect your repository to look like by the end of the tutorial. As we go through each step we will highlight the files/folders you will be working on with a `<` symbol +In the file structures shown below, we've used the `<`` symbol next to files or folders to indicate those you'll be working on or creating during this tutorial. @@ -64,7 +64,7 @@ app-antoniostacos < ::: -Create a [new repository](https://github.com/new) with your application name, such as: `app-antoniostacos`. +Go to GitHub and create a [new repository](https://github.com/new). When naming your repository, you can use a format like `app-yourprojectname`, for example: `app-antoniostacos`. ## Add your application code and Dockerfile @@ -174,7 +174,7 @@ Save the file and commit your changes. ### Dockerfile -Next, create a `Dockerfile` using the template below within your application repository +Next, within your application repository, create a new file named `Dockerfile`. Populate this file using the template provided below based on your chosen programming language. @@ -271,7 +271,7 @@ app-antoniostacos ::: -Creating this `YAML` will add a GitHub Action that will automatically publish a Docker image of your application to the GitHub Container Registry (GHCR.io). This will allow the GlueOps platform to use the latest version of your app in it's deployments. As a happy path, we have provided this [custom action to push Docker images to your GitHub Container Registry (GHCR.io)](https://github.com/marketplace/actions/build-docker-image-and-push-to-ghcr). +By creating and saving the following YAML configuration, you're setting up a GitHub Action that will automatically publish a Docker image of your application to the GitHub Container Registry (GHCR.io). This will allow the GlueOps platform to use the latest version of your app in it's deployments. As a happy path, we have provided this [custom action to push Docker images to your GitHub Container Registry (GHCR.io)](https://github.com/marketplace/actions/build-docker-image-and-push-to-ghcr). To use it, Simply create the file below @@ -292,27 +292,28 @@ Save the file and commit your changes and push up your changes. :::tip -Once you push up your changes visit your github repository actions page to view the status. You can find it at: https://github.com///actions. If you see nothing but "Green" circles then everything completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact(s) published to: https://github.com///packages. +Once you push up your changes visit your github repository actions page to view the status. You can find it at: https://github.com///actions. If all the circles next to your actions are "Green", it indicates that the processes completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact(s) published to: https://github.com///packages. ::: ## Let's deploy your app! :::info -Below is an example of the structure we will be adding to your "deployment configurations" repository. The exact name and location of this repository will be provided to your by a Platform Administrator. +**Deployment Configuration Repository:** +Think of this repository as your application's deployment instruction manual. It contains all the essential rules and settings that determine how and where your application should be launched. You don't need to delve into the nitty-gritty of these configurations. Just follow the steps below, and our system will handle the deployment seamlessly. + +**IMPORTANT: The exact name and location of this repository will be provided by your Platform Administrators.** ``` ├── apps │ └── app-antoniostacos │ └── envs │ └── qa -│ └── values.yaml +│ └── values.yaml < ``` ::: -We are almost at the end, let's get your app deployed so your QA team can check it out! - -Within your "deployment configurations" repository just create this file: +Now, within your "deployment configurations" repository, create the following file: ```yaml title="apps//envs/qa/values.yaml" image: @@ -343,10 +344,11 @@ ingress: ``` :::tip -You must replace the placeholders as follows: -- Replace `` and `` with your github organization name and your application repository name. -- Replace `` with your own friendly app name. -- Replace `` with your captain domain. This is environment specific and provided by your Platform Administrators. +Ensure you replace the placeholders appropriately: + +- `` and `` with your GitHub organization and application repository names. +- Replace `` with your chosen app name. +- Replace `` with your assigned captain domain, provided by the Platform Administrators. ::: -Save and commit your changes to the deployment configurations repository and push up the changes. Within a minute you should see your app at: https://-qa.apps. +Once you've done the above, commit your changes to the deployment configurations repository and push the changes. In a short while, you should be able to access your app at the URL: `https://-qa.apps.` From 0f395926c4eab2cacbb24629e90d18c1eaa1b753 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sun, 17 Sep 2023 00:10:31 +0000 Subject: [PATCH 18/20] cleanup --- docs/deploy-applications/hello-world.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index c591063b4..1a6447340 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -301,9 +301,11 @@ Once you push up your changes visit your github repository actions page to view **Deployment Configuration Repository:** Think of this repository as your application's deployment instruction manual. It contains all the essential rules and settings that determine how and where your application should be launched. You don't need to delve into the nitty-gritty of these configurations. Just follow the steps below, and our system will handle the deployment seamlessly. - -**IMPORTANT: The exact name and location of this repository will be provided by your Platform Administrators.** +::::danger important + The exact name and location of this "deployment configurations" repository will be provided by your Platform Administrators. +:::: ``` +deployment-configurations ├── apps │ └── app-antoniostacos │ └── envs From d72ee8389b4149ba5492d9aaca2e50db18096fc2 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sun, 17 Sep 2023 00:11:33 +0000 Subject: [PATCH 19/20] fix --- docs/deploy-applications/hello-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index 1a6447340..d2568a96e 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -292,7 +292,7 @@ Save the file and commit your changes and push up your changes. :::tip -Once you push up your changes visit your github repository actions page to view the status. You can find it at: https://github.com///actions. If all the circles next to your actions are "Green", it indicates that the processes completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact(s) published to: https://github.com///packages. +Once you push up your changes visit your github repository actions page to view the status. You can find it at: https://github.com///actions. If all the circles next to your actions are "Green", it indicates that the processes completed successfully. If you see any "Red" circles then you may need to revisit the steps above before continuing. In the end you should see an artifact published to: https://github.com///packages. ::: ## Let's deploy your app! From 92d1d2f31e4892983ab96724b63951b154be9080 Mon Sep 17 00:00:00 2001 From: Venkata Mutyala Date: Sun, 17 Sep 2023 00:16:59 +0000 Subject: [PATCH 20/20] fix --- docs/deploy-applications/hello-world.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/deploy-applications/hello-world.md b/docs/deploy-applications/hello-world.md index d2568a96e..4951512e4 100644 --- a/docs/deploy-applications/hello-world.md +++ b/docs/deploy-applications/hello-world.md @@ -17,7 +17,7 @@ import TabItem from '@theme/TabItem'; :::note -In the file structures shown below, we've used the `<`` symbol next to files or folders to indicate those you'll be working on or creating during this tutorial. +In the file structures shown below, we've used the `<` symbol next to files or folders to indicate those you'll be working on or creating during this tutorial.