Skip to content

Commit

Permalink
additional fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@deerskindoll
deerskindoll committed Feb 6, 2024
1 parent d74d2ff commit 7523334
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 9 deletions.
6 changes: 5 additions & 1 deletion modules/administration-guide/pages/configuring-storage-sizes.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="configuring-storage-sizes"]
= Configuring storage sizes

pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->]

You can configure the persistent volume claim (PVC) size using the `per-user` or `per-workspace` storage strategies. You must specify the PVC sizes in the `CheCluster` Custom Resource in the format of a link:https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[{kubernetes} resource quantity]. For more details on the available storage strategies, see xref:configuring-the-storage-strategy.adoc[this page].

Default persistent volume claim sizes:
Expand Down Expand Up @@ -53,4 +55,6 @@ spec:
----
<1> Select the storage strategy: `per-user` or `per-workspace` or `ephemeral`. Note: the `ephemeral` storage strategy does not use persistent storage, therefore you cannot configure its storage size or other PVC-related attributes.
<2> Specify a claim size on the next line or omit the next line to set the default claim size value. The specified claim size is only used when you select this storage strategy.
<3> The claim size must be specified as a link:https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[Kubernetes resource quantity]. The available quantity units include: `Ei`, `Pi`, `Ti`, `Gi`, `Mi` and `Ki`.
<3> The claim size must be specified as a link:https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[{kubernetes} resource quantity]. The available quantity units include: `Ei`, `Pi`, `Ti`, `Gi`, `Mi` and `Ki`.

Check warning on line 58 in modules/administration-guide/pages/configuring-storage-sizes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'io/docs'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'io/docs'", "location": {"path": "modules/administration-guide/pages/configuring-storage-sizes.adoc", "range": {"start": {"line": 58, "column": 67}}}, "severity": "WARNING"}

Check warning on line 58 in modules/administration-guide/pages/configuring-storage-sizes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'api/common'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'api/common'", "location": {"path": "modules/administration-guide/pages/configuring-storage-sizes.adoc", "range": {"start": {"line": 58, "column": 96}}}, "severity": "WARNING"}

Check warning on line 58 in modules/administration-guide/pages/configuring-storage-sizes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'definitions/quantity'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'definitions/quantity'", "location": {"path": "modules/administration-guide/pages/configuring-storage-sizes.adoc", "range": {"start": {"line": 58, "column": 107}}}, "severity": "WARNING"}

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]
6 changes: 3 additions & 3 deletions modules/end-user-guide/pages/authenticating-to-a-git-server-from-a-workspace.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ User authentication to a Git server from a workspace is configured by the admini

* As a workaround, some users create and apply their own {kubernetes} Secrets for their personal xref:using-a-git-provider-access-token.adoc[Git-provider access tokens] or link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[configure SSH keys for Git operations].

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

.Additional resources
* xref:administration-guide:configuring-oauth-for-git-providers.adoc[Administration Guide: Configuring OAuth for Git providers]
* xref:using-a-git-provider-access-token.adoc[User Guide: Using a Git-provider access token]
* link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[Configuring DevWorkspaces to use SSH keys for Git operations]
* link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[Configuring DevWorkspaces to use SSH keys for Git operations]

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]
4 changes: 2 additions & 2 deletions modules/end-user-guide/pages/requesting-persistent-storage-for-workspaces.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ To preserve the workspace state in persistent storage while the workspace is sto

You can request a PV by using the devfile or a {kubernetes} PersistentVolumeClaim (PVC).

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

An example of a PV is the `/projects/` directory of a workspace, which is mounted by default for non-ephemeral workspaces.

Persistent Volumes come at a cost: attaching a persistent volume slows workspace startup.
Expand All @@ -33,3 +31,5 @@ Starting another, concurrently running workspace with a link:https://kubernetes.

include::partial$proc_requesting-persistent-storage-in-a-devfile.adoc[leveloffset=+1]
include::partial$proc_requesting-persistent-storage-in-a-pvc.adoc[leveloffset=+1]

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]
6 changes: 3 additions & 3 deletions ...es/end-user-guide/pages/using-credentials-and-configurations-in-workspaces.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,12 @@ To do so, mount your credentials and configurations to the `{devworkspace}` cont

* Mount your credentials and sensitive configurations as {kubernetes} xref:mounting-secrets.adoc[Secrets].

* Mount your non-sensitve configurations as {kubernetes} xref:mounting-configmaps.adoc[ConfigMaps].
* Mount your non-sensitive configurations as {kubernetes} xref:mounting-configmaps.adoc[ConfigMaps].

If you need to allow the `{devworkspace}` Pods in the cluster to access container registries that require authentication, create an xref:creating-image-pull-secrets.adoc[image pull Secret] for the `{devworkspace}` Pods.

The mounting process uses the standard {kubernetes} mounting mechanism and requires applying additional labels and annotations to your existing resources. Resources are mounted when starting a new workspace or restarting an existing one.

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

You can create permanent mount points for various components:

* Maven configuration, such as the link:https://maven.apache.org/settings.html[user-specific] `settings.xml` file
Expand All @@ -37,3 +35,5 @@ You can create permanent mount points for various components:

* link:https://kubernetes.io/docs/concepts/configuration/secret/[Kubernetes Documentation: Secrets]
* link:https://kubernetes.io/docs/concepts/configuration/configmap/[Kubernetes Documentation: ConfigMaps]

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

0 comments on commit 7523334

Please sign in to comment.