dcos-app-deploy/plugin.yaml added

Author: eugene-codefresh

stable/dcos-app-deploy/NOTES.md

@@ -0,0 +1 @@
+## Notes

stable/dcos-app-deploy/README.md

@@ -0,0 +1,101 @@
+# cf-deploy-dcos
+The repository contains code for `codefresh/cf-deploy-dcos` image building. This image makes an application deployment on DC/OS cluster using application definition json file.
+It takes application deployment template (deployment.tmpl) and generates application deployment json file substituting variables in the template with the the environment variables values then applies the application deployment json file to DC/OS cluster using DC/OS CLI command.
+
+
+# Usage
+In order to use the `codefresh/cf-deploy-dcos` image we need to do the following:
+
+1. Define environment variables in Codefresh pipeline.
+
+- `DCOS_URL` **required** - DC/OS cluster URL
+- `DCOS_CLUSTER_NAME` **required** - DC/OS cluster name
+- `DCOS_CLUSTER_ID` **required** - DC/OS cluster ID
+- `DCOS_DCOS_ACS_TOKEN` **required** - DC/OS cluster existing user's token (make it encrypted)
+- `DCOS_SSL_VERIFY` default is true, if we want to bypass SSL certificate verification - set it to `false`
+- `APP_ID` - application name
+- `IMAGE_NAME` - application image name
+- `IMAGE_TAG` - application image tag
+
+2. Create deployment.tmpl and codefresh.yml files in an application repository at the root level.
+
+```
+codefresh.yml
+---
+version: '1.0'
+steps:
+  BuildingDockerImage:
+    type: build
+    image_name: applcation/image
+    ...
+
+  PushToRegistry:
+    type: push
+    candidate: ${{BuildingDockerImage}}
+    ...
+
+  DeployToDcos:
+    image: codefresh/cf-deploy-dcos:latest
+    working_directory: ${{main_clone}}
+    commands:
+      - /cf-deploy-dcos deployment.tmpl
+    environment:
+      - DCOS_URL=${{DCOS_URL}}
+      - DCOS_CLUSTER_NAME=${{DCOS_CLUSTER_NAME}}
+      - DCOS_CLUSTER_ID=${{DCOS_CLUSTER_ID}}
+      - DCOS_DCOS_ACS_TOKEN=${{DCOS_DCOS_ACS_TOKEN}}
+      - DCOS_SSL_VERIFY=${{DCOS_SSL_VERIFY}}
+      - APP_ID=${{APP_ID}}
+      - IMAGE_NAME=${{IMAGE_NAME}}
+      - IMAGE_TAG=${{IMAGE_TAG}}
+```
+We define freestyle step (DeployToDcos in the example above) and environment variables the same as in the Codefresh pipeline.
+
+```
+deployment.tmpl
+
+{
+  "id": "{{APP_ID}}",
+  "instances": 1,
+  "cpus": 0.1,
+  "mem": 64,
+  "container": {
+    "type" : "DOCKER",
+    "docker": {
+      "image": "{{IMAGE_NAME}}:{{IMAGE_TAG}}",
+      "forcePullImage": true,
+      "privileged": false,
+      "network": "BRIDGE",
+      "portMappings": [
+        { "hostPort": 80, "containerPort": 8081, "protocol": "tcp", "name": "http"}
+      ]
+    }
+  },
+   "acceptedResourceRoles": [
+     "slave_public"
+   ]
+}
+```
+`APP_ID`, `IMAGE_NAME` and `IMAGE_TAG` variables are just examples. We can parametrise any value in application deployment template depending on our requirements.
+But if we set some parameter `{{PARAMETER}}` in application deployment template we should ensure that this parameter is set both in Codefresh pipeline and in codefresh.yml freestyle step as well.
+
+Notes: we can use already configured DC/OS CLI dcos command to get DC/OS cluster parameters.
+Example:
+```
+dcos cluster list --attached --json
+
+[
+  {
+    "attached": true,
+    "cluster_id": "9d50f776-****-433c-****-ebb01eaafbbc",
+    "name": "dcos-master",
+    "url": "https://dcos-master.cloudapp.azure.com",
+    "version": "1.10.2"
+  }
+]
+```
+```
+dcos config show core.dcos_acs_token
+
+eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6Ik9UQkVOakZFTWtWQ09VRTRPRVpGTlRNMFJrWXlRa015Tnprd1JrSkVRemRCTWpBM1FqYzVOZyJ9.ey********
+```

stable/dcos-app-deploy/plugin.yaml

@@ -0,0 +1,34 @@
+image: codefresh/cf-deploy-dcos
+tag: latest
+version: 0.1.0
+description: Deploy an application on dcos cluster
+keywords:
+  - dcos
+  - deploy
+  - deployment
+home: https://github.com/codefresh-io/cf-deploy-dcos
+sources:
+  - https://github.com/codefresh-io/cf-deploy-dcos
+maintainers: # (optional)
+  - name: Eugene Semirski
+    email: eugene@codefresh.io
+icon: https://avatars0.githubusercontent.com/u/29493517?v=4&s=400
+envs:
+  - name: DCOS_URL
+    type: required
+    description: DC/OS cluster URL
+  - name: DCOS_CLUSTER_NAME
+    type: required
+    description: DC/OS cluster name
+  - name: DCOS_CLUSTER_ID
+    type: required
+    description: DC/OS cluster ID
+  - name: DCOS_DCOS_ACS_TOKEN
+    type: required
+    description: DC/OS cluster existing user's token
+  - name: DCOS_SSL_VERIFY
+    type: not_required
+    description: default is true, if we want to bypass SSL certificate verification - set it to false
+  - name: PARAMETER
+    type: not_required
+    description: see README.md for details