Update dev documentation websites

MAIF · Jun 22, 2020 · 95935a3 · 95935a3
1 parent 7fdd804
commit 95935a3
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 4 deletions.
diff --git a/docs/devmanual/content-pretty.json b/docs/devmanual/content-pretty.json
diff --git a/docs/devmanual/content.json b/docs/devmanual/content.json
diff --git a/docs/devmanual/deploy/kubernetes.html b/docs/devmanual/deploy/kubernetes.html
@@ -929,6 +929,9 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-cloud-provider-managed
             value: ${clientSecret}
           - name: ADMIN_API_ADDITIONAL_EXPOSED_DOMAIN
             value: otoroshi-api-service.${namespace}.svc.cluster.local
+          - name: OTOROSHI_INITIAL_CUSTOMIZATION
+            value: &gt;
+              {\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}
         readinessProbe:
           httpGet:
             path: /health
@@ -1078,6 +1081,9 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-bare-metal-kubernetes-
             value: ${clientSecret}
           - name: ADMIN_API_ADDITIONAL_EXPOSED_DOMAIN
             value: otoroshi-api-service.${namespace}.svc.cluster.local
+          - name: OTOROSHI_INITIAL_CUSTOMIZATION
+            value: &gt;
+              {\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}
         readinessProbe:
           httpGet:
             path: /health
@@ -1303,6 +1309,9 @@ <h3><a href="#deploy-a-simple-otoroshi-instanciation-on-a-bare-metal-kubernetes-
             value: ${clientSecret}
           - name: ADMIN_API_ADDITIONAL_EXPOSED_DOMAIN
             value: otoroshi-api-service.${namespace}.svc.cluster.local
+          - name: OTOROSHI_INITIAL_CUSTOMIZATION
+            value: &gt;
+              {\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}
         readinessProbe:
           httpGet:
             path: /health
@@ -1522,6 +1531,9 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-cloud-provider-managed-kubernetes-
             value: ${clientSecret}
           - name: CLUSTER_LEADER_CLIENT_SECRET
             value: ${clientSecret}
+          - name: OTOROSHI_INITIAL_CUSTOMIZATION
+            value: &gt;
+              {\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}
         readinessProbe:
           httpGet:
             path: /health
@@ -1815,6 +1827,9 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster" nam
             value: ${clientSecret}
           - name: CLUSTER_LEADER_CLIENT_SECRET
             value: ${clientSecret}
+          - name: OTOROSHI_INITIAL_CUSTOMIZATION
+            value: &gt;
+              {\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}
         readinessProbe:
           httpGet:
             path: /health
@@ -2163,6 +2178,9 @@ <h3><a href="#deploy-an-otoroshi-cluster-on-a-bare-metal-kubernetes-cluster-usin
             value: ${clientSecret}
           - name: CLUSTER_LEADER_CLIENT_SECRET
             value: ${clientSecret}
+          - name: OTOROSHI_INITIAL_CUSTOMIZATION
+            value: &gt;
+              {\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}
         readinessProbe:
           httpGet:
             path: /health

diff --git a/docs/devmanual/firstrun/configfile.html b/docs/devmanual/firstrun/configfile.html
@@ -794,6 +794,14 @@ <h2><a href="#reference-configuration" name="reference-configuration" class="anc
   overheadThreshold = ${?OVERHEAD_THRESHOLD}
   adminLogin = ${?OTOROSHI_INITIAL_ADMIN_LOGIN}
   adminPassword = ${?OTOROSHI_INITIAL_ADMIN_PASSWORD}
+  initialCustomization = &quot;{\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}&quot;
+  initialCustomization = ${?OTOROSHI_INITIAL_CUSTOMIZATION}
+  #initialCustomization = &quot;{\&quot;config\&quot;:{\&quot;otoroshiId\&quot;:\&quot;foobar\&quot;}}&quot;
+  #initialCustomization {
+  #  config {
+  #    otoroshiId = &quot;foooobar&quot;
+  #  }
+  #}
   instance {
     instanceId = ${?OTOROSHI_INSTANCE_ID}
     number = 0

diff --git a/docs/devmanual/firstrun/env.html b/docs/devmanual/firstrun/env.html
@@ -241,6 +241,13 @@ <h2><a href="#reference-configuration-for-env-variables" name="reference-configu
   overheadThreshold = ${?OVERHEAD_THRESHOLD}
   adminLogin = ${?OTOROSHI_INITIAL_ADMIN_LOGIN}
   adminPassword = ${?OTOROSHI_INITIAL_ADMIN_PASSWORD}
+  initialCustomization = &quot;{\&quot;config\&quot;:{\&quot;scripts\&quot;:{\&quot;enabled\&quot;:true,\&quot;jobRefs\&quot;:[\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\&quot;,\&quot;cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\&quot;],\&quot;jobConfig\&quot;:{\&quot;KubernetesConfig\&quot;:{\&quot;trust\&quot;:false,\&quot;namespaces\&quot;:[\&quot;*\&quot;],\&quot;labels\&quot;:[],\&quot;ingressClasses\&quot;:[\&quot;otoroshi\&quot;],\&quot;defaultGroup\&quot;:\&quot;default\&quot;,\&quot;ingresses\&quot;:true,\&quot;crds\&quot;:true,\&quot;kubeLeader\&quot;:false,\&quot;restartDependantDeployments\&quot;:false,\&quot;templates\&quot;:{\&quot;service-group\&quot;:{},\&quot;service-descriptor\&quot;:{},\&quot;apikeys\&quot;:{},\&quot;global-config\&quot;:{},\&quot;jwt-verifier\&quot;:{},\&quot;tcp-service\&quot;:{},\&quot;certificate\&quot;:{},\&quot;auth-module\&quot;:{},\&quot;script\&quot;:{}}}}}}}&quot;
+  initialCustomization = ${?OTOROSHI_INITIAL_CUSTOMIZATION}
+  #initialCustomization = &quot;{\&quot;config\&quot;:{\&quot;otoroshiId\&quot;:\&quot;foobar\&quot;}}&quot;
+  #initialCustomization {
+  #  config {
+  #  }
+  #}
   instance {
     instanceId = ${?OTOROSHI_INSTANCE_ID}
     number =  ${?OTOROSHI_INSTANCE_NUMBER}

diff --git a/docs/devmanual/snippets/reference-env.conf b/docs/devmanual/snippets/reference-env.conf
@@ -14,6 +14,13 @@ app {
   overheadThreshold = ${?OVERHEAD_THRESHOLD}
   adminLogin = ${?OTOROSHI_INITIAL_ADMIN_LOGIN}
   adminPassword = ${?OTOROSHI_INITIAL_ADMIN_PASSWORD}
+  initialCustomization = "{\"config\":{\"scripts\":{\"enabled\":true,\"jobRefs\":[\"cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\",\"cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\"],\"jobConfig\":{\"KubernetesConfig\":{\"trust\":false,\"namespaces\":[\"*\"],\"labels\":[],\"ingressClasses\":[\"otoroshi\"],\"defaultGroup\":\"default\",\"ingresses\":true,\"crds\":true,\"kubeLeader\":false,\"restartDependantDeployments\":false,\"templates\":{\"service-group\":{},\"service-descriptor\":{},\"apikeys\":{},\"global-config\":{},\"jwt-verifier\":{},\"tcp-service\":{},\"certificate\":{},\"auth-module\":{},\"script\":{}}}}}}}"
+  initialCustomization = ${?OTOROSHI_INITIAL_CUSTOMIZATION}
+  #initialCustomization = "{\"config\":{\"otoroshiId\":\"foobar\"}}"
+  #initialCustomization {
+  #  config {
+  #  }
+  #}
   instance {
     instanceId = ${?OTOROSHI_INSTANCE_ID}
     number =  ${?OTOROSHI_INSTANCE_NUMBER}

diff --git a/docs/devmanual/snippets/reference.conf b/docs/devmanual/snippets/reference.conf
@@ -29,6 +29,14 @@ app {
   overheadThreshold = ${?OVERHEAD_THRESHOLD}
   adminLogin = ${?OTOROSHI_INITIAL_ADMIN_LOGIN}
   adminPassword = ${?OTOROSHI_INITIAL_ADMIN_PASSWORD}
+  initialCustomization = "{\"config\":{\"scripts\":{\"enabled\":true,\"jobRefs\":[\"cp:otoroshi.plugins.jobs.kubernetes.KubernetesIngressControllerJob\",\"cp:otoroshi.plugins.jobs.kubernetes.KubernetesOtoroshiCRDsControllerJob\"],\"jobConfig\":{\"KubernetesConfig\":{\"trust\":false,\"namespaces\":[\"*\"],\"labels\":[],\"ingressClasses\":[\"otoroshi\"],\"defaultGroup\":\"default\",\"ingresses\":true,\"crds\":true,\"kubeLeader\":false,\"restartDependantDeployments\":false,\"templates\":{\"service-group\":{},\"service-descriptor\":{},\"apikeys\":{},\"global-config\":{},\"jwt-verifier\":{},\"tcp-service\":{},\"certificate\":{},\"auth-module\":{},\"script\":{}}}}}}}"
+  initialCustomization = ${?OTOROSHI_INITIAL_CUSTOMIZATION}
+  #initialCustomization = "{\"config\":{\"otoroshiId\":\"foobar\"}}"
+  #initialCustomization {
+  #  config {
+  #    otoroshiId = "foooobar"
+  #  }
+  #}
   instance {
     instanceId = ${?OTOROSHI_INSTANCE_ID}
     number = 0

diff --git a/manual/src/main/paradox/content-pretty.json b/manual/src/main/paradox/content-pretty.json
diff --git a/manual/src/main/paradox/content.json b/manual/src/main/paradox/content.json