Add CPU limis/requets into plugin container description (#1079)

eclipse-che · Feb 17, 2020 · c2d9f34 · c2d9f34
1 parent babc813
commit c2d9f34
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/...er-guide/proc_writing-a-meta-yaml-file-and-adding-it-to-a-plug-in-registry.adoc b/...er-guide/proc_writing-a-meta-yaml-file-and-adding-it-to-a-plug-in-registry.adoc
@@ -28,7 +28,10 @@ spec:
   containers:                                                   <12>
     - image:                                                    <13>
       memoryLimit:                                              <14>
-  extensions:                                                   <15>
+      memoryRequest:                                            <15>
+      cpuLimit:                                                 <16>
+      cpuRequest:                                               <17>
+  extensions:                                                   <18>
     - https://github.com/redhat-developer/vscode-yaml/releases/download/0.4.0/redhat.vscode-yaml-0.4.0.vsix
     - vscode:extension/SonarSource.sonarlint-vscode
 ----
@@ -45,5 +48,8 @@ spec:
 <11> Defines the category that this plug-in belongs to. Should be one of the following: `Editor`, `Debugger`, `Formatter`, `Language`, `Linter`, `Snippet`, `Theme`, or `Other`.
 <12> If this section is omitted, the VS Code extension is added into the Che-Theia IDE container.
 <13> The Docker image from which the sidecar container will be started. Example: `eclipse/che-theia-endpoint-runtime:next`.
-<14> The RAM which is given for the sidecar container by default. Example: "256Mi". This value might be overridden by the user in the component configuration.
-<15> A list of VS Code extensions that should be run in this sidecar container.
+<14> The maximum RAM which is available for the sidecar container. Example: "512Mi". This value might be overridden by the user in the component configuration.
+<15> The RAM which is given for the sidecar container by default. Example: "256Mi". This value might be overridden by the user in the component configuration.
+<16> The maximum CPU amount in cores or millicores (suffixed with "m") which is available for the sidecar container. Examples: "500m", "2". This value might be overridden by the user in the component configuration.
+<17> The CPU amount in cores or millicores (suffixed with "m") which is given for the sidecar container by default. Example: "125m". This value might be overridden by the user in the component configuration.
+<18> A list of VS Code extensions that should be run in this sidecar container.
diff --git a/src/main/pages/che-7/end-user-guide/ref_che-theia-plug-in-metadata.adoc b/src/main/pages/che-7/end-user-guide/ref_che-theia-plug-in-metadata.adoc
@@ -38,7 +38,10 @@ The link:https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins[c
 :===
 `name`: sidecar container name
 `image`: container image
-`memorylimit`: Kubernetes/OpenShift-spec memory limit string (e.g. "512Mi")
+`memoryLimit`: Kubernetes/OpenShift-spec memory limit string (e.g. "512Mi")
+`memoryRequest`: Kubernetes/OpenShift-spec memory request string (e.g. "512Mi")
+`cpuLimit`: Kubernetes/OpenShift-spec CPU limit string (e.g. "2500m")
+`cpuRequest`: Kubernetes/OpenShift-spec CPU request string (e.g. "125m")
 `env`: list of environment variables to set in sidecar
 `command`: string array definition of the root process command inside container.
 `args`: string array arguments for the root process command inside container