docs for helm and dockerlayer

replicatedhq · Jun 16, 2018 · 1539fb1 · 1539fb1
1 parent b8c24e6
commit 1539fb1
Show file tree

Hide file tree

Showing 10 changed files with 223 additions and 49 deletions.
diff --git a/hack/docs/mutations.json b/hack/docs/mutations.json
@@ -85,13 +85,13 @@
   {
     "path": "properties.assets.properties.v1.items.properties.docker.properties.image",
     "merge": {
-      "description": "The destination for the docker image, such as `api.tar` or `docker-images/worker.tar`."
+      "description": "The docker image URL"
     }
   },
   {
     "path": "properties.assets.properties.v1.items.properties.docker.properties.source",
     "merge": {
-      "description": "The source for the image. Should be either `public`, `replicated`, or the name of a third-party private registry previously configured on [vendor.replicated.com](https://vendor.replicated.com)"
+      "description": "The source for the image. Should be either `public`, `replicated`, or the name of a third-party private registry previously configured on [console.replicated.com](https://console.replicated.com)"
     }
   },
   {
@@ -100,6 +100,128 @@
       "description": "The unix file permissions to be set on the image tar archive, e.g `600`"
     }
   },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm",
+    "merge": {
+      "description": "A `helm` asset will template and render an existing helm chart. Your installer runbook should included assets to drop an existing helm chart at `local.chart_root`. Future releases will include support for charts stored in private github repos or in chart repositories like ChartMuseum.",
+      "examples": [
+        {
+          "values":  {
+            "AppFlavor": "ship",
+            "NginxReplicas": "{{repl ConfigOption \\\"nginx_replicas\\\"}}"
+          },
+          "helm_opts": [
+            "--name",
+            "{{repl Installation \\\"channel_name\\\"}}-{{repl Installation \\\"semver\\\"}}"
+          ],
+          "local": {
+            "chart_root": "charts/src/nginx/"
+          },
+          "dest": "charts/rendered/"
+        }
+      ]
+    },
+    "replace": {
+      "required": [
+        "dest",
+        "local"
+      ]
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm.properties.dest",
+    "merge": {
+      "description": "The directory in which to render the. If the source chart is at `charts/src/nginx`, and `dest` is set to `charts/rendered/`, then the chart will be templated at `charts/rendered/nginx`"
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm.properties.helm_opts",
+    "merge": {
+      "description": "Additional options as would be passed to `helm template`"
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm.properties.local",
+    "merge": {
+      "description": "Configuration for indicating an already existing source chart to render from."
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm.properties.local.properties.chart_root",
+    "merge": {
+      "description": "The base directory of the existing chart."
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm.properties.mode",
+    "merge": {
+      "description": "The unix permisions to set on the chart's parent directory"
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm.properties.values",
+    "merge": {
+      "description": "Values to set during rendering, overrides defaults in `values.yaml` if present in the chart root."
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.helm.properties.values.properties[\".*\"]",
+    "merge": {
+      "description": "Key-value pairs to set."
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.dockerlayer",
+    "merge": {
+      "description": "A `dockerlayer` asset will pull an image from registry.replicated.com or from a configured third party private registry and extract a single layer from the image in a `dest` directory",
+      "examples": [
+        {
+          "image": "quay.io/cooltool-enterprise/configs:1.0.1",
+          "dest": "config/",
+          "source": "quayio-private",
+          "layer": "f7126e84abc96fbc8495c33052724fad48115829e86987adbf556474f0ead5c1"
+        }
+      ]
+    },
+    "replace": {
+      "required": [
+        "dest",
+        "image",
+        "source",
+        "layer"
+      ]
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.dockerlayer.properties.dest",
+    "merge": {
+      "description": "The directory in which the layer should be unpacked"
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.dockerlayer.properties.image",
+    "merge": {
+      "description": "The docker image URL"
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.dockerlayer.properties.source",
+    "merge": {
+      "description": "The source for the image. Should be either `public`, `replicated`, or the name of a third-party private registry previously configured on [console.replicated.com](https://console.replicated.com)"
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.dockerlayer.properties.mode",
+    "merge": {
+      "description": "The unix file permissions to be set on target unpack directory, e.g `777`"
+    }
+  },
+  {
+    "path": "properties.assets.properties.v1.items.properties.dockerlayer.properties.layer",
+    "merge": {
+      "description": "a SHA256 of the layer to extract. You can inspect the layer SHAs of a docker image by running something like `docker save myimage > myimage.tar && tar xvf myimage.tar -C /tmp`. Ship will unpack the archive at `<layer sha>/layer.tar` to the `dest` directory."
+    }
+  },
   {
     "path": "properties.assets.properties.v1.items.properties.github",
     "merge": {
@@ -132,7 +254,7 @@
   {
     "path": "properties.config.properties.v1.items",
     "replace": {
-      "required": ["name", "title", "items"]
+      "required": ["name", "items"]
     }
   },
   {
@@ -178,25 +300,18 @@
     "merge": {
       "description": "A `render` step will do the work of collecting configuration values from a user and using them to generate the final assets that can be used to deploy an application.",
       "examples": [
-        {},
-        { "skip_plan": true, "skip_state_warning": true }
+        {}
       ]
     },
     "replace": {
       "required": []
     }
   },
   {
-    "path": "properties.lifecycle.properties.v1.items.properties.render.properties.skip_plan",
-    "merge": {
-      "description": "Whether to skip the \"plan\" phase of `render`, in which the user can confirm the actions that Ship will take to generate application assets"
-    }
-  },
-  {
-    "path": "properties.lifecycle.properties.v1.items.properties.render.properties.skip_state_warning",
-    "merge": {
-      "description": "If set to `true`, will omit the default warning message informing the user that a state file has been created and to save that state file for future ship runs. If this is set to `true`, your YAML should specify a `message` step that explains the purpose and importance of this state file."
-    }
+    "path": "properties.assets.properties.v1.items.properties",
+    "delete": [
+      "github"
+    ]
   },
   {}
 ]
diff --git a/hack/docs/schema.json b/hack/docs/schema.json
@@ -40,15 +40,15 @@
                     "type": "string"
                   },
                   "image": {
-                    "description": "The destination for the docker image, such as `api.tar` or `docker-images/worker.tar`.",
+                    "description": "The docker image URL",
                     "type": "string"
                   },
                   "mode": {
                     "description": "The unix file permissions to be set on the image tar archive, e.g `600`",
                     "type": "integer"
                   },
                   "source": {
-                    "description": "The source for the image. Should be either `public`, `replicated`, or the name of a third-party private registry previously configured on [vendor.replicated.com](https://vendor.replicated.com)",
+                    "description": "The source for the image. Should be either `public`, `replicated`, or the name of a third-party private registry previously configured on [console.replicated.com](https://console.replicated.com)",
                     "type": "string"
                   }
                 },
@@ -58,15 +58,14 @@
                   "source"
                 ]
               },
-              "github": {
-                "description": "A `github` asset is created from files downloaded from either a public or a linked Github repo.",
+              "dockerlayer": {
+                "description": "A `dockerlayer` asset will pull an image from registry.replicated.com or from a configured third party private registry and extract a single layer from the image in a `dest` directory",
                 "examples": [
                   {
-                    "repo": "github.com/replicatedhq/superbigtool-k8s",
-                    "ref": "8fcaebe55af67fe6789fa678faaa76fa867fbc",
-                    "path": "**/*.yml",
-                    "dest": "./k8s/",
-                    "private": true
+                    "image": "quay.io/cooltool-enterprise/configs:1.0.1",
+                    "dest": "config/",
+                    "source": "quayio-private",
+                    "layer": "f7126e84abc96fbc8495c33052724fad48115829e86987adbf556474f0ead5c1"
                   }
                 ],
                 "type": "object",
@@ -75,29 +74,98 @@
                     "type": "string"
                   },
                   "dest": {
+                    "description": "The directory in which the layer should be unpacked",
+                    "type": "string"
+                  },
+                  "image": {
+                    "description": "The docker image URL",
+                    "type": "string"
+                  },
+                  "layer": {
+                    "description": "a SHA256 of the layer to extract. You can inspect the layer SHAs of a docker image by running something like `docker save myimage > myimage.tar && tar xvf myimage.tar -C /tmp`. Ship will unpack the archive at `<layer sha>/layer.tar` to the `dest` directory.",
                     "type": "string"
                   },
                   "mode": {
+                    "description": "The unix file permissions to be set on target unpack directory, e.g `777`",
                     "type": "integer"
                   },
-                  "path": {
+                  "source": {
+                    "description": "The source for the image. Should be either `public`, `replicated`, or the name of a third-party private registry previously configured on [console.replicated.com](https://console.replicated.com)",
                     "type": "string"
-                  },
-                  "ref": {
+                  }
+                },
+                "required": [
+                  "dest",
+                  "image",
+                  "source",
+                  "layer"
+                ]
+              },
+              "helm": {
+                "description": "A `helm` asset will template and render an existing helm chart. Your installer runbook should included assets to drop an existing helm chart at `local.chart_root`. Future releases will include support for charts stored in private github repos or in chart repositories like ChartMuseum.",
+                "examples": [
+                  {
+                    "values": {
+                      "AppFlavor": "ship",
+                      "NginxReplicas": "{{repl ConfigOption \\\"nginx_replicas\\\"}}"
+                    },
+                    "helm_opts": [
+                      "--name",
+                      "{{repl Installation \\\"channel_name\\\"}}-{{repl Installation \\\"semver\\\"}}"
+                    ],
+                    "local": {
+                      "chart_root": "charts/src/nginx/"
+                    },
+                    "dest": "charts/rendered/"
+                  }
+                ],
+                "type": "object",
+                "properties": {
+                  "description": {
                     "type": "string"
                   },
-                  "repo": {
+                  "dest": {
+                    "description": "The directory in which to render the. If the source chart is at `charts/src/nginx`, and `dest` is set to `charts/rendered/`, then the chart will be templated at `charts/rendered/nginx`",
                     "type": "string"
                   },
-                  "source": {
-                    "type": "string"
+                  "helm_opts": {
+                    "description": "Additional options as would be passed to `helm template`",
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "local": {
+                    "description": "Configuration for indicating an already existing source chart to render from.",
+                    "type": "object",
+                    "properties": {
+                      "chart_root": {
+                        "description": "The base directory of the existing chart.",
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "chart_root"
+                    ]
+                  },
+                  "mode": {
+                    "description": "The unix permisions to set on the chart's parent directory",
+                    "type": "integer"
+                  },
+                  "values": {
+                    "description": "Values to set during rendering, overrides defaults in `values.yaml` if present in the chart root.",
+                    "type": "object",
+                    "properties": {
+                      ".*": {
+                        "description": "Key-value pairs to set.",
+                        "type": "string"
+                      }
+                    }
                   }
                 },
                 "required": [
-                  "repo",
-                  "path",
                   "dest",
-                  "source"
+                  "local"
                 ]
               },
               "inline": {
@@ -211,7 +279,6 @@
             },
             "required": [
               "name",
-              "title",
               "items"
             ]
           }
@@ -257,23 +324,9 @@
               "render": {
                 "description": "A `render` step will do the work of collecting configuration values from a user and using them to generate the final assets that can be used to deploy an application.",
                 "examples": [
-                  {},
-                  {
-                    "skip_plan": true,
-                    "skip_state_warning": true
-                  }
+                  {}
                 ],
                 "type": "object",
-                "properties": {
-                  "skip_plan": {
-                    "description": "Whether to skip the \"plan\" phase of `render`, in which the user can confirm the actions that Ship will take to generate application assets",
-                    "type": "boolean"
-                  },
-                  "skip_state_warning": {
-                    "description": "If set to `true`, will omit the default warning message informing the user that a state file has been created and to save that state file for future ship runs. If this is set to `true`, your YAML should specify a `message` step that explains the purpose and importance of this state file.",
-                    "type": "boolean"
-                  }
-                },
                 "required": []
               }
             }

diff --git a/vendor/github.com/docker/docker/hack/generate-authors.sh b/vendor/github.com/docker/docker/hack/generate-authors.sh
diff --git a/vendor/github.com/docker/docker/integration-cli/fixtures/https/ca.pem b/vendor/github.com/docker/docker/integration-cli/fixtures/https/ca.pem
diff --git a/vendor/github.com/docker/docker/integration-cli/fixtures/https/client-cert.pem b/vendor/github.com/docker/docker/integration-cli/fixtures/https/client-cert.pem
diff --git a/vendor/github.com/docker/docker/integration-cli/fixtures/https/client-key.pem b/vendor/github.com/docker/docker/integration-cli/fixtures/https/client-key.pem
diff --git a/vendor/github.com/docker/docker/integration-cli/fixtures/https/server-cert.pem b/vendor/github.com/docker/docker/integration-cli/fixtures/https/server-cert.pem
diff --git a/vendor/github.com/docker/docker/integration-cli/fixtures/https/server-key.pem b/vendor/github.com/docker/docker/integration-cli/fixtures/https/server-key.pem
diff --git a/vendor/github.com/docker/docker/project/CONTRIBUTING.md b/vendor/github.com/docker/docker/project/CONTRIBUTING.md
diff --git a/vendor/github.com/onsi/ginkgo/before_pr.sh b/vendor/github.com/onsi/ginkgo/before_pr.sh