From 7c57971b23ba17c39a6bd41ea0a4dfa5bb4a71b0 Mon Sep 17 00:00:00 2001 From: Aleksandr Melnikov Date: Wed, 17 Jun 2020 10:56:18 -0700 Subject: [PATCH 1/3] Adding documentation for containerRuntimeExecutor parameter. --- docs/deployment/configuration/files.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/deployment/configuration/files.md b/docs/deployment/configuration/files.md index 6beff86d..2a637874 100644 --- a/docs/deployment/configuration/files.md +++ b/docs/deployment/configuration/files.md @@ -240,6 +240,18 @@ artifactRepository: Onepanel Workflows will automatically upload or download artifacts from `artifacts/{{workflow.namespace}}/{{workflow.name}}/{{pod.name}}`. See [Workflow artifacts](/docs/reference/workflows/templates#artifacts) for more information. ::: +### containerRuntimeExecutor +This parameter allows you to adjust the workflow executors that argo uses. +Specifies the container runtime interface to use (default: docker). + +Some are more performant than others, some are more secure. + +See references: +- https://github.com/argoproj/argo/blob/master/docs/workflow-executors.md#docker-docker +- https://github.com/argoproj/argo/blob/master/docs/workflow-controller-configmap.yaml + +Must be one of: `docker`, `kubelet`, `k8sapi`, `pns` + ### certManager If you have run `opctl init` with `--enable-https`, `--enable-cert-manager` and `--dns-provider` flags set, you need to configure your respective DNS provider here so that Onepanel can create and renew your TLS certificates for you. From 5240ab4d54a03e179d88ed617db7d9c54b407d04 Mon Sep 17 00:00:00 2001 From: Aleksandr Melnikov Date: Wed, 17 Jun 2020 12:28:11 -0700 Subject: [PATCH 2/3] Fixing the URL reference. --- docs/deployment/configuration/files.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/deployment/configuration/files.md b/docs/deployment/configuration/files.md index 2a637874..40fe3aa3 100644 --- a/docs/deployment/configuration/files.md +++ b/docs/deployment/configuration/files.md @@ -247,8 +247,8 @@ Specifies the container runtime interface to use (default: docker). Some are more performant than others, some are more secure. See references: -- https://github.com/argoproj/argo/blob/master/docs/workflow-executors.md#docker-docker -- https://github.com/argoproj/argo/blob/master/docs/workflow-controller-configmap.yaml +- [Argo Workflow Executors](https://github.com/argoproj/argo/blob/master/docs/workflow-executors.md#docker-docker) +- [Argo Workflow ConfigMap](https://github.com/argoproj/argo/blob/master/docs/workflow-controller-configmap.yaml) Must be one of: `docker`, `kubelet`, `k8sapi`, `pns` From 0bbfead98db77209dfedeb689b11d34fe0760213 Mon Sep 17 00:00:00 2001 From: rushtehrani Date: Thu, 18 Jun 2020 17:34:56 -0700 Subject: [PATCH 3/3] remove deprecated sections and update workflowEngine section --- docs/deployment/configuration/files.md | 44 ++++++++++---------------- 1 file changed, 16 insertions(+), 28 deletions(-) diff --git a/docs/deployment/configuration/files.md b/docs/deployment/configuration/files.md index 40fe3aa3..a379f0db 100644 --- a/docs/deployment/configuration/files.md +++ b/docs/deployment/configuration/files.md @@ -26,16 +26,6 @@ The template below is automatically generated when your run `opctl init` for you # Description: Onepanel application information # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - application: - cloud: - # GRPC port for API - apiGRPCPort: 8887 - # Path of API relative to host - apiPath: /api - # HTTP or HTTPS - Do not change, determined by `opctl init --enable-https` - # CLI flag: --enable-https - insecure: false - # Path of UI relative to host - uiPath: / # First namespace that will be created in Onepanel, more can be added later defaultNamespace: default # Domain or IP where Onepanel is hosted @@ -46,6 +36,9 @@ application: # Use the same IP address as `domain` above if running local, use `minikube ip` or `multipass list` to get this IP # In the cloud, if `domain` above is set to example.com or sub.example.com, then your FQDN could be: app.example.com or app.sub.example.com respectively fqdn: + # HTTP or HTTPS - Do not change, determined by `opctl init --enable-https` + # CLI flag: --enable-https + insecure: false # Node pool or group label keys and values used for AutoScaling and for NodeSelectors # The provider will set these label key and values on your nodes automatically # These can also be customized depending on your provider @@ -170,11 +163,6 @@ This is where you set the basic application configuration. Below are the sections you will need to adjust. -#### cloud -Everything under this section is generated and should not be manually changed. - -The `insecure` field is set to `true` by default and will be set to `false` if you add the `--enable-https` when running `opctl init`. - #### defaultNamespace This is the first [Namespace](/docs/getting-started/concepts/namespaces) you want created. This could be a project name or a team name. It is set to `default` by default but we recommend you use something more meaningful. @@ -184,6 +172,9 @@ This is the domain for your Onepanel resources. Some resources like Workspaces c #### fqdn This is where Onepanel UI and API will be deployed. This should be a subdomain of the `domain` field mentioned above. Example: `app.example.com` or `app.sub.example.com`. +#### insecure +The `insecure` field is set to `true` by default and will be set to `false` if you add the `--enable-https` when running `opctl init`. + #### nodePool Depending on your provider, these are either called node pools or node groups. They are labels on Kubernetes nodes that Onepanel uses for auto scaling nodes on demand. @@ -240,18 +231,6 @@ artifactRepository: Onepanel Workflows will automatically upload or download artifacts from `artifacts/{{workflow.namespace}}/{{workflow.name}}/{{pod.name}}`. See [Workflow artifacts](/docs/reference/workflows/templates#artifacts) for more information. ::: -### containerRuntimeExecutor -This parameter allows you to adjust the workflow executors that argo uses. -Specifies the container runtime interface to use (default: docker). - -Some are more performant than others, some are more secure. - -See references: -- [Argo Workflow Executors](https://github.com/argoproj/argo/blob/master/docs/workflow-executors.md#docker-docker) -- [Argo Workflow ConfigMap](https://github.com/argoproj/argo/blob/master/docs/workflow-controller-configmap.yaml) - -Must be one of: `docker`, `kubelet`, `k8sapi`, `pns` - ### certManager If you have run `opctl init` with `--enable-https`, `--enable-cert-manager` and `--dns-provider` flags set, you need to configure your respective DNS provider here so that Onepanel can create and renew your TLS certificates for you. @@ -281,4 +260,13 @@ database: :::important For a production environment, use a managed database service and set the configuration accordingly. -::: \ No newline at end of file +::: + +### workflowEngine +#### containerRuntimeExecutor +The executor workflow engine uses to perform certain actions like monitoring pod logs, collecting artifacts, managing container lifecycles, etc. + +The possible values are `docker` and `pns`: + +- `docker` is more reliable, however it mounts the `docker.sock` of the host makes it less secure. +- `pns` is more secure, however in some versions of Kubernetes, it tends to fail on tasks that take less than 15 seconds. \ No newline at end of file