Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eug and IG markup fixes #1700

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
{prod} provides developer workspaces with everything needed to a code, build, test, run, and debug applications. To allow that, the developer workspaces provide four main components:

. The source code of a project.
. A web-based IDE.
. A web-based integrated development environment (IDE).
. Tool dependencies, needed by developers to work on a project
. Application runtime: a replica of the environment where the application runs in production

Expand Down
20 changes: 18 additions & 2 deletions modules/end-user-guide/partials/con_a-minimal-devfile.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,23 @@ metadata:
For a complete devfile example, see link:https://github.com/eclipse/che/blob/master/devfile.yaml[{prod} in {prod-short} devfile.yaml].

[NOTE]
.`name` or `generateName` must be defined
====
Both `name` and `generateName` are optional parameters, but at least one of them must be defined. See xref:#generating-workspace-names_{context}[].
A choice of use of the parameter `generateName` or `name` is optional, but only one of these parameters has to be chosen by a user and defined.
When both attributes are specified, `generateName` is ignored.
See xref:#generating-workspace-names_{context}[].

[source,yaml]
----
metadata:
generatedName:
----

or

[source,yaml]
----
metadata:
name:
----
====

Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ projects:
...
----

When overriding attributes, everything that follows the `attributes` keyword is interpreted as an attribute name, so you can use dot-separated names:
When overriding attributes, everything that follows the `attributes` keyword is interpreted as an attribute name, so a user can use dot-separated names:

[subs="+quotes"]
----
Expand Down
20 changes: 10 additions & 10 deletions modules/end-user-guide/partials/ref_devfile-reference.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -323,10 +323,10 @@ apiVersion: 1.0.0
metadata:
name: MyDevfile
components:
type: dockerimage
image: golang
memoryLimit: 512Mi
command: ['sleep', 'infinity']
- type: dockerimage
image: golang
memoryLimit: 512Mi
command: ['sleep', 'infinity']
----

It specifies the type of the component, `dockerimage` and the `image` attribute names the image to be used for the component using the usual Docker naming conventions, that is, the above `type` attribute is equal to `docker.io/library/golang:latest`.
Expand All @@ -343,11 +343,10 @@ apiVersion: 1.0.0
metadata:
name: MyDevfile
components:
type: dockerimage
image: golang
memoryLimit: 512Mi
mountSources: true
command: ['sleep', 'infinity']
- type: dockerimage
image: golang
memoryLimit: 512Mi
command: ['sleep', 'infinity']
----

The sources is mounted on a location stored in the `CHE_PROJECTS_ROOT` environment variable that is made available in the running container of the image. This location defaults to `/projects`.
Expand Down Expand Up @@ -561,7 +560,8 @@ the {platforms-namespace} to which the workspace is deployed.

* `CHE_MACHINE_TOKEN`: The token used to authenticate the request against the {prod-short} server.

* `CHE_MACHINE_AUTH_SIGNATURE__PUBLIC__KEY`: The public key used to secure the communication with the {prod-short} server.
[subs="+quotes,macros"]
* `pass:[CHE_MACHINE_AUTH_SIGNATURE__PUBLIC__KEY]`: The public key used to secure the communication with the {prod-short} server.

* `CHE_MACHINE_AUTH_SIGNATURE__ALGORITHM`: The encryption algorithm used in the secured communication with the {prod-short} server.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ The `customCheProperties` field, part of the `CheCluster` Custom Resource `serve
map of additional environment variables to apply to the {prod-short} server component.

.Override the default memory limit for workspaces

====
* Add the `CHE_WORKSPACE_DEFAULT\__MEMORY__LIMIT__MB` property to `customCheProperties`:
[subs="+quotes,macros"]
* Add the `pass:[CHE_WORKSPACE_DEFAULT__MEMORY__LIMIT__MB]` property to `customCheProperties`:
+
[source,yaml,subs="+quotes,+attributes,+macros"]
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,9 @@ CHE_INFRA_KUBERNETES_NAMESPACE_DEFAULT=__{prod-workspace}__-__<username>__
ifeval::["{project-context}" == "che"]
* For Helm Chart deployments, set the following environment variable in the {prod-short} ConfigMap:
+
[subs="+quotes,macros"]
----
CHE_INFRA_KUBERNETES_NAMESPACE_ALLOW__USER__DEFINED=true
pass:[CHE_INFRA_KUBERNETES_NAMESPACE_ALLOW__USER__DEFINED]=true
----
endif::[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ CHE_WORKSPACE_POD_NODE__SELECTOR=disktype=ssd,cpu=xlarge,[key=value]

To avoid Pods and PVCs to be scheduled in different zones on large, multi-zone clusters, create an additional link:https://kubernetes.io/docs/concepts/storage/storage-classes/[`StorageClass`] object (pay attention to the `allowedTopologies` field), which will coordinate the PVC creation process.

Pass the name of this newly created `StorageClass` to {prod-short} through the `CHE_INFRA_KUBERNETES_PVC_STORAGE__CLASS__NAME` environment variable. A default empty value of this variable instructs {prod-short} to use the cluster's default `StorageClass`.
Pass the name of this newly created `StorageClass` to {prod-short} through the `+CHE_INFRA_KUBERNETES_PVC_STORAGE__CLASS__NAME+` environment variable. A default empty value of this variable instructs {prod-short} to use the cluster's default `StorageClass`.
====