From ef4d6fa1ecc8ea82096f4a4ebe4f55abb2eff6e1 Mon Sep 17 00:00:00 2001 From: dgreen15 Date: Wed, 22 Jan 2025 09:25:29 -0500 Subject: [PATCH 1/5] Update software_templates.md --- .../en/service_catalog/software_templates.md | 33 ++++++++++++------- 1 file changed, 22 insertions(+), 11 deletions(-) diff --git a/content/en/service_catalog/software_templates.md b/content/en/service_catalog/software_templates.md index bc683520d2cf0..ac06b7b508340 100644 --- a/content/en/service_catalog/software_templates.md +++ b/content/en/service_catalog/software_templates.md @@ -35,16 +35,32 @@ The [Scaffold New Service blueprint][11] shows an example of scaffolding a new l ##### Create S3 Bucket with Terraform -The [Create S3 Bucket with Terraform blueprint][10] shows an example of creating the terraform for an S3 bucket from a form in Github. +The [Create S3 Bucket blueprint][10] shows an example of creating the terraform for an S3 bucket from a form in Github. + +#### Provision Kubernetes Cluster + +The [Provision EKS Cluster blueprint][12] shows an example of creating the terraform for a new Kubernetes cluster in Github. + +#### Provision RDS Instance + +The [Provision RDS Instance blueprint][13] shows an example of provisioning a new RDS instance via direct integration with AWS. + #### Start from scratch Navigate to the [Workflow Automation][3] page to configure the template in Datadog. -1. [Create a workflow][6] for your template: +1. Create the form for your template: + - Navigate to **Actions** > **App Builder** and select **New App**. + - Enter a name and description, and use the drag-and-drop editor to create a form that collects the required parameters for your template. + - Select **New Query**, and use the **Trigger workflow** action to call your templating workflow and pass in the relevant parameters. + - Create a **Button** that submits the form, triggers your workflow, and passes in the parameters for the template. + - Save and publish the app. + +2. [Create a workflow][6] for your template: - From the [Workflow Automation][3] page, click **New Workflow**. - Enter a name, add relevant tags, and define the input parameters you want to collect from users. -2. Configure the templating workflow: +3. Configure the templating workflow: - Use GitHub, Gitlab, or HTTP [actions][7] to retrieve your template files. - Use Cookiecutter to generate the project files from the template. - Use the Apply Template [action][7] to manipulate your template repository and pass in your input parameters. @@ -53,14 +69,7 @@ Navigate to the [Workflow Automation][3] page to configure the template in Datad {{< img src="tracing/service_catalog/templating-workflow.png" alt="Workflow for building software template automation" style="width:100%;" >}} -3. Create the form for your template: - - Navigate to **Service Mgmt** > **App Builder** and select **New App**. - - Enter a name and description, and use the drag-and-drop editor to create a form that collects the required parameters for your template. - - Select **New Query**, and use the **Trigger workflow** action to call your templating workflow and pass in the relevant parameters. - - Create a **Button** that submits the form, triggers your workflow, and passes in the parameters for the template. - - Save and publish the app. - -4. Run your application and workflow: +4. Test your application and workflow: - Click **View App** to view the app on a standalone page, or **Add to a Dashboard** to place the app in a dashboard. - Navigate to **Service Mgmt** > **App Builder**, and select your app. Fill out the template form, and click the submit button. - Track the success of the workflow templating process in [Workflow Automation][3]. @@ -105,3 +114,5 @@ Below is a comprehensive list of actions available for Service Catalog in Datado [10]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=queries&showActionCatalog=false&template=create-new-s3-bucket&viewMode=edit [11]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=queries&showActionCatalog=false&template=scaffolding&viewMode=edit [12]: /actions/private_actions/ +[13]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=data&showActionCatalog=false&template=provision-eks-cluster&viewMode=edit&visibleDataItemId=createOrUpdateFile0-action +[14]: https://app.datadoghq.com/app-builder/apps/edit?activeTab=data&showActionCatalog=false&template=rds_provision_instance&viewMode=edit&visibleDataItemId=createDbInstance0-action From c835fb34580d0ba541f6ca3aad8c9b7d772b2bd7 Mon Sep 17 00:00:00 2001 From: dgreen15 Date: Wed, 22 Jan 2025 09:26:42 -0500 Subject: [PATCH 2/5] Update software_templates.md --- content/en/service_catalog/software_templates.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/service_catalog/software_templates.md b/content/en/service_catalog/software_templates.md index ac06b7b508340..88e38962d3c8f 100644 --- a/content/en/service_catalog/software_templates.md +++ b/content/en/service_catalog/software_templates.md @@ -37,11 +37,11 @@ The [Scaffold New Service blueprint][11] shows an example of scaffolding a new l The [Create S3 Bucket blueprint][10] shows an example of creating the terraform for an S3 bucket from a form in Github. -#### Provision Kubernetes Cluster +##### Provision Kubernetes Cluster The [Provision EKS Cluster blueprint][12] shows an example of creating the terraform for a new Kubernetes cluster in Github. -#### Provision RDS Instance +##### Provision RDS Instance The [Provision RDS Instance blueprint][13] shows an example of provisioning a new RDS instance via direct integration with AWS. From 951e7f1d5ce12f98116376d5149d2ab2fec7da3f Mon Sep 17 00:00:00 2001 From: domalessi <111786334+domalessi@users.noreply.github.com> Date: Fri, 24 Jan 2025 17:35:45 -0500 Subject: [PATCH 3/5] Apply suggestions from code review --- content/en/service_catalog/software_templates.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/en/service_catalog/software_templates.md b/content/en/service_catalog/software_templates.md index 88e38962d3c8f..84f9076661752 100644 --- a/content/en/service_catalog/software_templates.md +++ b/content/en/service_catalog/software_templates.md @@ -33,17 +33,17 @@ The [Scaffold New Service blueprint][11] shows an example of scaffolding a new l 1. From the app, customize the form to include the parameters you want to capture from your developers. 2. Click **Save as New App** to save the app. This will also create a corresponding templating workflow. -##### Create S3 Bucket with Terraform +##### Create S3 bucket with Terraform -The [Create S3 Bucket blueprint][10] shows an example of creating the terraform for an S3 bucket from a form in Github. +The [Create S3 Bucket blueprint][10] shows an example of how to generate Terraform code for an S3 bucket using a form in GitHub. -##### Provision Kubernetes Cluster +##### Provision Kubernetes cluster -The [Provision EKS Cluster blueprint][12] shows an example of creating the terraform for a new Kubernetes cluster in Github. +The [Provision EKS Cluster blueprint][12] shows an example of how to generate Terraform code for a new Kubernetes cluster in GitHub. -##### Provision RDS Instance +##### Provision RDS instance -The [Provision RDS Instance blueprint][13] shows an example of provisioning a new RDS instance via direct integration with AWS. +The [Provision RDS Instance blueprint][13] shows an example of how to provision a new RDS instance through direct integration with AWS. #### Start from scratch From ac8cd8e9dda93d17c149e9be7696adb3055e9777 Mon Sep 17 00:00:00 2001 From: domalessi <111786334+domalessi@users.noreply.github.com> Date: Fri, 24 Jan 2025 17:36:20 -0500 Subject: [PATCH 4/5] Update content/en/service_catalog/software_templates.md --- content/en/service_catalog/software_templates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/service_catalog/software_templates.md b/content/en/service_catalog/software_templates.md index 84f9076661752..cd55790f03f61 100644 --- a/content/en/service_catalog/software_templates.md +++ b/content/en/service_catalog/software_templates.md @@ -43,7 +43,7 @@ The [Provision EKS Cluster blueprint][12] shows an example of how to generate Te ##### Provision RDS instance -The [Provision RDS Instance blueprint][13] shows an example of how to provision a new RDS instance through direct integration with AWS. +The [Provision RDS Instance blueprint][13] shows an example of how to provision an RDS instance through direct integration with AWS. #### Start from scratch From f68caa35c9fc60778d2c870a6c4b2f6b4408211b Mon Sep 17 00:00:00 2001 From: domalessi <111786334+domalessi@users.noreply.github.com> Date: Fri, 24 Jan 2025 17:36:37 -0500 Subject: [PATCH 5/5] Update content/en/service_catalog/software_templates.md --- content/en/service_catalog/software_templates.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/service_catalog/software_templates.md b/content/en/service_catalog/software_templates.md index cd55790f03f61..9e866c38a38be 100644 --- a/content/en/service_catalog/software_templates.md +++ b/content/en/service_catalog/software_templates.md @@ -39,7 +39,7 @@ The [Create S3 Bucket blueprint][10] shows an example of how to generate Terrafo ##### Provision Kubernetes cluster -The [Provision EKS Cluster blueprint][12] shows an example of how to generate Terraform code for a new Kubernetes cluster in GitHub. +The [Provision EKS Cluster blueprint][12] shows an example of how to generate Terraform code for a Kubernetes cluster in GitHub. ##### Provision RDS instance