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

chore: Remove some outdated PVC storage properties #330

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ che.websocket.internal.endpoint=NULL
# workspace. This is the directory in the machine where your projects are placed.
che.workspace.projects.storage=/projects

# Used when {orch-name}-type components in a devfile request project PVC creation
# (Applied in case of `unique` and `per workspace` PVC strategy. In case of the `common` PVC strategy,
# it is rewritten with the value of the `che.infra.kubernetes.pvc.quantity` property.)
che.workspace.projects.storage.default.size=1Gi

# Defines the directory inside the machine where all the workspace logs are placed.
# Provide this value into the machine, for example, as an environment variable.
# This is to ensure that agent developers can use this directory to back up agent logs.
Expand Down Expand Up @@ -368,50 +363,6 @@ che.infra.kubernetes.ingress_start_timeout_min=5
# A failed container startup is handled explicitly by {prod-short} server.
che.infra.kubernetes.workspace_unrecoverable_events=FailedMount,FailedScheduling,MountVolume.SetUp failed,Failed to pull image,FailedCreate,ReplicaSetCreateError

# Defines whether use the Persistent Volume Claim for {prod-short} workspace needs,
# for example: backup projects, logs, or disable it.
che.infra.kubernetes.pvc.enabled=true

# Defined which strategy will be used while choosing PVC for workspaces.
#
# Supported strategies:
# `common`::
# All workspaces in the same {orch-namespace} will reuse the same PVC.
# Name of PVC may be configured with `che.infra.kubernetes.pvc.name`.
# Existing PVC will be used or a new one will be created if it does not exist.
#
# `unique`::
# Separate PVC for each workspace's volume will be used.
# Name of PVC is evaluated as `'{che.infra.kubernetes.pvc.name} + '-' + {generated_8_chars}'`.
# Existing PVC will be used or a new one will be created if it does not exist.
#
# `per-workspace`::
# Separate PVC for each workspace will be used.
# Name of PVC is evaluated as `'{che.infra.kubernetes.pvc.name} + '-' + {WORKSPACE_ID}'`.
# Existing PVC will be used or a new one will be created if it doesn't exist.
che.infra.kubernetes.pvc.strategy=common

# Defines whether to run a job that creates workspace's subpath directories in persistent volume for the `common` strategy before launching a workspace.
# Necessary in some versions of {orch-name} as workspace subpath volume mounts are created with root permissions,
# and therefore cannot be modified by workspaces running as a user (presents an error importing projects into a workspace in {prod-short}).
# The default is `true`, but should be set to `false` if the version of {orch-name} creates subdirectories with user permissions.
# See: link:https://github.com/kubernetes/kubernetes/issues/41638[subPath in volumeMount is not writable for non-root users #41638]
# the {prod-short} Operator that this property has effect only if the `common` PVC strategy used.
che.infra.kubernetes.pvc.precreate_subpaths=true

# Defines the settings of PVC name for {prod-short} workspaces.
# Each PVC strategy supplies this value differently.
# See documentation for `che.infra.kubernetes.pvc.strategy` property
che.infra.kubernetes.pvc.name=claim-che-workspace

# Defines the storage class of Persistent Volume Claim for the workspaces.
# Empty strings means "use default".
che.infra.kubernetes.pvc.storage_class_name=

# Defines the size of Persistent Volume Claim of {prod-short} workspace.
# See: link:https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html[Understanding persistent storage]
che.infra.kubernetes.pvc.quantity=10Gi

# Pod that is launched when performing persistent volume claim maintenance jobs on OpenShift
che.infra.kubernetes.pvc.jobs.image=registry.access.redhat.com/ubi8-minimal:8.3-230

Expand All @@ -421,20 +372,6 @@ che.infra.kubernetes.pvc.jobs.image.pull_policy=IfNotPresent
# Defines Pod memory limit for persistent volume claim maintenance jobs
che.infra.kubernetes.pvc.jobs.memorylimit=250Mi

# Defines Persistent Volume Claim access mode.
# the {prod-short} Operator that for common PVC strategy changing of access mode affects the number of simultaneously running workspaces.
# If the OpenShift instance running {prod-short} is using Persistent Volumes with RWX access mode, then a limit of running workspaces at the same time is bounded only by {prod-short} limits configuration: RAM, CPU, and so on.
# See: link:https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html[Understanding persistent storage]
che.infra.kubernetes.pvc.access_mode=ReadWriteOnce

# Defines if {prod-short} Server should wait workspaces Persistent Volume Claims to become bound after creating.
# Default value is `true`.
# The parameter is used by all Persistent Volume Claim strategies.
#
# It should be set to `false` when `volumeBindingMode` is configured to `WaitForFirstConsumer` otherwise workspace starts will hangs up on phase of waiting PVCs.
#
che.infra.kubernetes.pvc.wait_bound=true

# Defines annotations for ingresses which are used for servers exposing. Value depends on the kind of ingress
# controller.
#
Expand Down Expand Up @@ -613,21 +550,6 @@ che.workspace.devfile_registry_url=https://che-devfile-registry.prod-preview.ope
# In case {prod-short} plug-ins registry is not needed value 'NULL' should be used
che.workspace.devfile_registry_internal_url=NULL

# The configuration property that defines available values for storage types that clients such as the Dashboard should propose to users during workspace creation and update.
# Available values:
# - `persistent`: Persistent Storage slow I/O but persistent.
# - `ephemeral`: Ephemeral Storage allows for faster I/O but may have limited storage
# and is not persistent.
# - `async`: Experimental feature: Asynchronous storage is combination of Ephemeral
# and Persistent storage. Allows for faster I/O and keep your changes, will backup on stop
# and restore on start workspace.
# Will work only if:
# - `che.infra.kubernetes.pvc.strategy='common'`
# - `che.limits.user.workspaces.run.count=1`
# - `che.infra.kubernetes.namespace.default` contains `<username>`
# in other cases remove `async` from the list.
che.workspace.storage.available_types=persistent,ephemeral,async

# The configuration property that defines a default value for storage type that clients such as the Dashboard should propose to users during workspace creation and update.
# The `async` value is an experimental feature, not recommended as default type.
che.workspace.storage.preferred_type=persistent
Expand Down