Merge pull request #174 from flanksource/playbook-updates

Playbook updates

.gitignore

@@ -1,3 +1,6 @@
+.envrc
+default.nix
+
 .DS_Store
 site/
 **/build/

.prettierrc

@@ -1,4 +1,5 @@
 {
   "semi": false,
-  "trailingComma": "none"
+  "trailingComma": "none",
+  "singleQuote": true
 }

mission-control/Makefile

@@ -1,6 +1,6 @@
 .PHONY:
 sync:
-	rm docs/canary-checker/index.md
+	rm -f docs/canary-checker/index.md
 
 watch: sync
 	npm exec -c 'docusaurus start'

mission-control/docs/playbooks/actions/azure_devops_pipeline.md

@@ -0,0 +1,68 @@
+---
+title: Azure DevOps Pipeline Action
+---
+
+# <Icon name="azure-devops"/> Azure DevOps Pipeline Action
+
+This action allows you to invoke pipelines in your Azure DevOps project.
+
+```yaml title="invoke-azure-devops-pipeline.yaml"
+apiVersion: mission-control.flanksource.com/v1
+kind: Playbook
+metadata:
+  name: invoke-azure-devops-pipeline
+  namespace: default
+spec:
+  parameters:
+    - name: project
+      label: Project name
+    - name: pipeline
+      label: Pipeline ID
+  actions:
+    - name: Invoke pipeline
+      azureDevopsPipeline:
+        org: flanksource
+        project: "{{.params.project}}"
+        token:
+          valueFrom:
+            secretKeyRef:
+              name: azure-devops
+              key: token
+        pipeline:
+          id: "{{.params.pipeline}}"
+```
+
+| Field        | Description                                                   | Scheme                                         | Required | Templatable |
+| ------------ | ------------------------------------------------------------- | ---------------------------------------------- | -------- | ----------- |
+| `org`        | Org is the name of the Azure DevOps organization.             | `string`                                       | `true`   | `true`      |
+| `project`    | Project ID or project name                                    | `string`                                       | `true`   | `true`      |
+| `token`      | Token is the personal access token.                           | <CommonLink to="secrets">_EnvVar_</CommonLink> | `true`   | `true`      |
+| `pipeline`   | Pipeline is the azure pipeline to invoke.                     | [`AzureDevopsPipeline`](#pipeline)             | `true`   | `true`      |
+| `parameters` | Parameteres are the settings that influence the pipeline run. | [`AzureDevopsPipelineParameters`](#parameters) | `false`  | `true`      |
+
+## Pipeline
+
+| Field     | Description       | Scheme   | Required | Templatable |
+| --------- | ----------------- | -------- | -------- | ----------- |
+| `id`      | Pipeline ID.      | `string` | `true`   | `true`      |
+| `version` | Pipeline version. | `string` | `false`  | `true`      |
+
+## Parameters
+
+| Field                | Description                               | Scheme           | Required | Templatable |
+| -------------------- | ----------------------------------------- | ---------------- | -------- | ----------- |
+| `resources`          | The resources the run requires.           | `map[string]any` | `false`  | `true`      |
+| `templateParameters` | The template parameters the run requires. | `map[string]any` | `false`  | `true`      |
+| `variables`          | The variables the run requires.           | `map[string]any` | `false`  | `true`      |
+| `stagesToSkip`       | The stages to skip.                       | `[]string`       | `false`  | `true`      |
+
+## Templating
+
+The fields that are marked as `templatable` receives a environment variable that contain details about the corresponding config, check or component and the parameter(if applicable).
+
+| Field       | Description                              | Schema                                       |
+| ----------- | ---------------------------------------- | -------------------------------------------- |
+| `config`    | Config passed to the playbook            | [`ConfigItem`](../references/config_item.md) |
+| `component` | Component passed to the playbook         | [`Component`](../references/component.md)    |
+| `check`     | Canary Check passed to the playbook      | [`Check`](../references/check.md)            |
+| `params`    | User provided parameters to the playbook | `map[string]string`                          |

mission-control/docs/playbooks/actions/gitops.md

@@ -49,7 +49,7 @@ spec:
 ```
 
 :::info
-On Github and Azure Devops, it's possible to create Pull Requests as well.
+On Github, GitLab and Azure Devops, it's possible to create Pull Requests as well.
 :::
 
 | Field     | Description                                                   | Scheme                                   | Required | Templatable |
@@ -66,15 +66,18 @@ At least a patch or files config is required.
 
 ### Repository Detail
 
-| Field        | Description                                                           | Scheme   | Required | Templatable |
-| ------------ | --------------------------------------------------------------------- | -------- | -------- | ----------- |
-| `connection` | Connection name to use the credentials for the git repo               | `string` |          |             |
-| `url`        | URL of the git repository                                             | `string` |          |             |
-| `base`       | Branch to clone. _(Defaults to "main")_                               | `string` |          | `true`      |
-| `branch`     | The new branch to create. _(Defaults to base branch specified above)_ | `string` |          | `true`      |
+| Field        | Description                                                               | Scheme   | Required | Templatable |
+| ------------ | ------------------------------------------------------------------------- | -------- | -------- | ----------- |
+| `connection` | Connection name to use the credentials for the git repo                   | `string` |          |             |
+| `url`        | URL of the git repository                                                 | `string` |          |             |
+| `base`       | Branch to clone. _(Defaults to "main")_                                   | `string` |          | `true`      |
+| `branch`     | The new branch to create. _(Defaults to base branch specified above)_     | `string` |          | `true`      |
+| `type`       | Specify the service the repository is hosted on (eg: github, gitlab, etc) | `string` |          |             |
 
 :::note
-Either the `connection` or the `url` is required
+Either the `connection` or the `url` is required.
+
+For private GitLab repositories, please sepcify the type as "gitlab"
 :::
 
 ### Commit Detail

mission-control/sidebars.js

@@ -530,6 +530,11 @@ const sidebars = {
       type: 'category',
       label: 'Actions',
       items: [
+        {
+          type: 'doc',
+          id: 'playbooks/actions/azure_devops_pipeline',
+          label: 'Azure DevOps Pipeline'
+        },
         {
           type: 'doc',
           id: 'playbooks/actions/exec',
@@ -538,7 +543,7 @@ const sidebars = {
         {
           type: 'doc',
           id: 'playbooks/actions/github',
-          label: 'Github'
+          label: 'GitHub'
         },
         {
           type: 'doc',