Skip to content

Configurable default PVC size for common and per-workspace storage classes - #827

Merged
AObuchow merged 3 commits into
devfile:mainfrom
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged

Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom
AObuchow:configurable_default_pvc_size

Conversation

@AObuchow

@AObuchowAObuchow commented Apr 26, 2022•
edited
Loading

Copy link
Copy Markdown
Collaborator

What does this PR do?

  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes

In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.

What issues does this PR fix or reference?

Fix#792.

Is it tested? How?

  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.
    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.

Additional WIP notes

  • Setting the storage class sizes with a CRD still needs to be manually tested

PR Checklist

  • E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)
    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che

@openshift-ci
openshift-ciBot requested a review from amisevskApril 26, 2022 14:16
@openshift-ci

openshift-ciBot commented Apr 26, 2022

Copy link
Copy Markdown

Hi @AObuchow. Thanks for your PR.

I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@AObuchow
AObuchowforce-pushed the configurable_default_pvc_size branch from 00bb54c to 30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk reviewed Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go Outdated
Comment threadpkg/config/defaults.go Outdated
@amisevsk

amisevsk commented Apr 26, 2022

Copy link
Copy Markdown
Collaborator

You'll need to rebase onto main (dropping the first commit)

@AObuchow
AObuchowforce-pushed the configurable_default_pvc_size branch from 30d5d73 to 7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow commented Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml Outdated
x-kubernetes-int-or-string: true
description: 'StorageClassSize defines an optional map of sizes
of persistent volume claims for each storage class used by DevWorkspaces.
The available keys to the map are: "common", "per-workspace".

@AObuchowAObuchowApr 26, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?

@AObuchowAObuchowApr 26, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P

@amisevskamisevskApr 27, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use

make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.

AObuchow
AObuchow commented Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go Outdated
amisevsk
amisevsk reviewed Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go Outdated
Comment threadpkg/config/sync.go Outdated
Comment threadpkg/config/sync.go Outdated
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go Outdated
Comment threadpkg/config/sync.go Outdated
AObuchow
AObuchow commented Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go Outdated
@AObuchow

AObuchow commented Apr 28, 2022

Copy link
Copy Markdown
CollaboratorAuthor

I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.

I also made sure that any other workspace I had (other than che-server) was deleted.

It says 545.4 MiB were used:
image

@AObuchow

AObuchow commented Apr 28, 2022

Copy link
Copy Markdown
CollaboratorAuthor

I opened che-code and built it on the dog fooding cluster.

After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.
After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)
After running yarn build, disk usage is 3.39GiB.
Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image

amisevsk
amisevsk reviewed Apr 28, 2022
View reviewed changes

@amisevskamisevsk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).

@amisevsk

amisevsk commented Apr 28, 2022

Copy link
Copy Markdown
Collaborator

I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.

AObuchow
AObuchow commented Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go Outdated
AObuchow
AObuchow commented Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow commented Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow requested a review from amisevskApril 29, 2022 16:53
AObuchow
AObuchow commented Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow commented Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go Outdated
AObuchow
AObuchow commented Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go Outdated
amisevsk
amisevsk reviewed Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go Outdated
@AObuchow

AObuchow commented May 2, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Not sure yet why the check sources CI is suddenly failing:

go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.

@amisevsk

amisevsk commented May 3, 2022

Copy link
Copy Markdown
Collaborator

#831 should fix PR check

@AObuchowAObuchow changed the title WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow marked this pull request as ready for review May 9, 2022 22:01
@AObuchow
AObuchow requested a review from ibuziuk as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk approved these changes May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go Outdated
Comment on lines +295 to +298
config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
}
if Workspace.DefaultStorageSize.PerWorkspace != nil {
config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))

@amisevskamisevskMay 11, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.

workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is

workspace.defaultStorageSize.perWorkspace
Suggested change
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
}
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
}
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))

@AObuchowAObuchowMay 11, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace

@amisevskamisevskMay 12, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.

@AObuchow
AObuchowforce-pushed the configurable_default_pvc_size branch from 276e56f to 9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot removed the lgtm label May 11, 2022
@AObuchow
AObuchow requested a review from amisevskMay 11, 2022 20:22
This was referenced May 13, 2022
Closed
Merged
ibuziuk
ibuziuk reviewed May 18, 2022
View reviewed changes

@ibuziukibuziuk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?

@AObuchow

AObuchow commented May 18, 2022

Copy link
Copy Markdown
CollaboratorAuthor

@AObuchow could you please resolve the conficts?

Sorry about that - will be done in a moment.

@AObuchow
AObuchowforce-pushed the configurable_default_pvc_size branch from 57f4be1 to c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow requested a review from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk approved these changes May 24, 2022
View reviewed changes

@ibuziukibuziuk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

amisevsk
amisevsk reviewed May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go Outdated
config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
}
if Workspace.DefaultStorageSize.PerWorkspace != nil {
config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))

@amisevskamisevskMay 24, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))

@AObuchowAObuchowMay 25, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge

@AObuchowAObuchowMay 25, 2022

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎

@openshift-ciopenshift-ciBot removed the lgtm label May 25, 2022
@AObuchow
AObuchowforce-pushed the configurable_default_pvc_size branch from ae1cfd2 to 3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed the configurable_default_pvc_size branch from 3932e90 to ac607dfCompareMay 25, 2022 14:36
@openshift-ci

openshift-ciBot commented May 25, 2022

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amisevsk, AObuchow, ibuziuk

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@amisevsk

amisevsk commented May 25, 2022

Copy link
Copy Markdown
Collaborator

/retest

@AObuchow
AObuchow merged commit 9b9d8fd into devfile:mainMay 27, 2022
@amisevskamisevsk mentioned this pull request Jun 23, 2022
Open
@l0rdl0rd mentioned this pull request Jul 27, 2022
Open
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk

@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)

3 participants

@AObuchow@amisevsk@ibuziuk
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Configurable default PVC size for common and per-workspace storage classes by AObuchow · Pull Request #827 · devfile/devworkspace-operator · GitHub
Skip to content
Configurable default PVC size for common and per-workspace storage classes - #827
Merged
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged
Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
Conversation
@AObuchow
@AObuchowAObuchow
commented
Apr 26, 2022•

edited

Loading

Copy link


Copy Markdown

Collaborator
What does this PR do?
  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes
In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.
What issues does this PR fix or reference?
Fix#792.
Is it tested? How?
  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.

    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.
Additional WIP notes
  • Setting the storage class sizes with a CRD still needs to be manually tested
PR Checklist
  •  E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)

    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che
@openshift-ci
openshift-ciBot
requested a review
from amisevskApril 26, 2022 14:16
@openshift-ci
openshift-ciBot
commented
Apr 26, 2022

Copy link


Copy Markdown

Hi @AObuchow. Thanks for your PR.
I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Details
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
00bb54c to
30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk
reviewed
Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/defaults.go
Outdated

@amisevsk
amisevsk
commented
Apr 26, 2022

Copy link


Copy Markdown

Collaborator
You'll need to rebase onto main (dropping the first commit)
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
30d5d73 to
7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml
Outdated

 x-kubernetes-int-or-string: true
 description: 'StorageClassSize defines an optional map of sizes
 of persistent volume claims for each storage class used by DevWorkspaces.
 The available keys to the map are: "common", "per-workspace".
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P
@amisevskamisevskApr 27, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use
make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.
I also made sure that any other workspace I had (other than che-server) was deleted.
It says 545.4 MiB were used:
image
@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-code and built it on the dog fooding cluster.
After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.

After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)

After running yarn build, disk usage is 3.39GiB.

Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image
amisevsk
amisevsk
reviewed
Apr 28, 2022
View reviewed changes
@amisevskamisevsk
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).
@amisevsk
amisevsk
commented
Apr 28, 2022

Copy link


Copy Markdown

Collaborator
I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow
requested a review
from amisevskApril 29, 2022 16:53
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
May 2, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Not sure yet why the check sources CI is suddenly failing:
go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.
@amisevsk
amisevsk
commented
May 3, 2022

Copy link


Copy Markdown

Collaborator
#831 should fix PR check
@AObuchowAObuchow
changed the title
WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow
marked this pull request as ready for review
May 9, 2022 22:01
@AObuchow
AObuchow
requested a review
from ibuziuk
as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk
approved these changes
May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated


Comment on lines

+295
 to 
+298

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 11, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.
workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is
workspace.defaultStorageSize.perWorkspace


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 11, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace
@amisevskamisevskMay 12, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
276e56f to
9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 11, 2022
@AObuchow
AObuchow
requested a review
from amisevskMay 11, 2022 20:22

This was referenced May 13, 2022

Closed

 Merged

ibuziuk
ibuziuk
reviewed
May 18, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?
@AObuchow
AObuchow
commented
May 18, 2022

Copy link


Copy Markdown

CollaboratorAuthor
@AObuchow could you please resolve the conficts?
Sorry about that - will be done in a moment.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
57f4be1 to
c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow
requested a review
from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk
approved these changes
May 24, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
amisevsk
amisevsk
reviewed
May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 24, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 25, 2022
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
ae1cfd2 to
3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
3932e90 to
ac607dfCompareMay 25, 2022 14:36
@openshift-ci
openshift-ciBot
commented
May 25, 2022

Copy link


Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: amisevsk, AObuchow, ibuziuk
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Details
Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment

Approvers can cancel approval by writing /approve cancel in a comment
@amisevsk
amisevsk
commented
May 25, 2022

Copy link


Copy Markdown

Collaborator
/retest
@AObuchow
AObuchow
merged commit 9b9d8fd
into
devfile:mainMay 27, 2022
@amisevskamisevsk
mentioned this pull request
Jun 23, 2022

Open

@l0rdl0rd
mentioned this pull request
Jul 27, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk
@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)


3 participants

@AObuchow@amisevsk@ibuziuk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Configurable default PVC size for common and per-workspace storage classes by AObuchow · Pull Request #827 · devfile/devworkspace-operator · GitHub
Skip to content
Configurable default PVC size for common and per-workspace storage classes - #827
Merged
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged
Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
Conversation
@AObuchow
@AObuchowAObuchow
commented
Apr 26, 2022•

edited

Loading

Copy link


Copy Markdown

Collaborator
What does this PR do?
  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes
In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.
What issues does this PR fix or reference?
Fix#792.
Is it tested? How?
  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.

    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.
Additional WIP notes
  • Setting the storage class sizes with a CRD still needs to be manually tested
PR Checklist
  •  E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)

    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che
@openshift-ci
openshift-ciBot
requested a review
from amisevskApril 26, 2022 14:16
@openshift-ci
openshift-ciBot
commented
Apr 26, 2022

Copy link


Copy Markdown

Hi @AObuchow. Thanks for your PR.
I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Details
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
00bb54c to
30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk
reviewed
Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/defaults.go
Outdated

@amisevsk
amisevsk
commented
Apr 26, 2022

Copy link


Copy Markdown

Collaborator
You'll need to rebase onto main (dropping the first commit)
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
30d5d73 to
7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml
Outdated

 x-kubernetes-int-or-string: true
 description: 'StorageClassSize defines an optional map of sizes
 of persistent volume claims for each storage class used by DevWorkspaces.
 The available keys to the map are: "common", "per-workspace".
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P
@amisevskamisevskApr 27, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use
make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.
I also made sure that any other workspace I had (other than che-server) was deleted.
It says 545.4 MiB were used:
image
@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-code and built it on the dog fooding cluster.
After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.

After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)

After running yarn build, disk usage is 3.39GiB.

Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image
amisevsk
amisevsk
reviewed
Apr 28, 2022
View reviewed changes
@amisevskamisevsk
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).
@amisevsk
amisevsk
commented
Apr 28, 2022

Copy link


Copy Markdown

Collaborator
I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow
requested a review
from amisevskApril 29, 2022 16:53
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
May 2, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Not sure yet why the check sources CI is suddenly failing:
go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.
@amisevsk
amisevsk
commented
May 3, 2022

Copy link


Copy Markdown

Collaborator
#831 should fix PR check
@AObuchowAObuchow
changed the title
WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow
marked this pull request as ready for review
May 9, 2022 22:01
@AObuchow
AObuchow
requested a review
from ibuziuk
as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk
approved these changes
May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated


Comment on lines

+295
 to 
+298

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 11, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.
workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is
workspace.defaultStorageSize.perWorkspace


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 11, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace
@amisevskamisevskMay 12, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
276e56f to
9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 11, 2022
@AObuchow
AObuchow
requested a review
from amisevskMay 11, 2022 20:22

This was referenced May 13, 2022

Closed

 Merged

ibuziuk
ibuziuk
reviewed
May 18, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?
@AObuchow
AObuchow
commented
May 18, 2022

Copy link


Copy Markdown

CollaboratorAuthor
@AObuchow could you please resolve the conficts?
Sorry about that - will be done in a moment.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
57f4be1 to
c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow
requested a review
from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk
approved these changes
May 24, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
amisevsk
amisevsk
reviewed
May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 24, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 25, 2022
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
ae1cfd2 to
3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
3932e90 to
ac607dfCompareMay 25, 2022 14:36
@openshift-ci
openshift-ciBot
commented
May 25, 2022

Copy link


Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: amisevsk, AObuchow, ibuziuk
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Details
Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment

Approvers can cancel approval by writing /approve cancel in a comment
@amisevsk
amisevsk
commented
May 25, 2022

Copy link


Copy Markdown

Collaborator
/retest
@AObuchow
AObuchow
merged commit 9b9d8fd
into
devfile:mainMay 27, 2022
@amisevskamisevsk
mentioned this pull request
Jun 23, 2022

Open

@l0rdl0rd
mentioned this pull request
Jul 27, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk
@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)


3 participants

@AObuchow@amisevsk@ibuziuk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Configurable default PVC size for common and per-workspace storage classes by AObuchow · Pull Request #827 · devfile/devworkspace-operator · GitHub
Skip to content
Configurable default PVC size for common and per-workspace storage classes - #827
Merged
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged
Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
Conversation
@AObuchow
@AObuchowAObuchow
commented
Apr 26, 2022•

edited

Loading

Copy link


Copy Markdown

Collaborator
What does this PR do?
  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes
In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.
What issues does this PR fix or reference?
Fix#792.
Is it tested? How?
  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.

    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.
Additional WIP notes
  • Setting the storage class sizes with a CRD still needs to be manually tested
PR Checklist
  •  E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)

    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che
@openshift-ci
openshift-ciBot
requested a review
from amisevskApril 26, 2022 14:16
@openshift-ci
openshift-ciBot
commented
Apr 26, 2022

Copy link


Copy Markdown

Hi @AObuchow. Thanks for your PR.
I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Details
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
00bb54c to
30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk
reviewed
Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/defaults.go
Outdated

@amisevsk
amisevsk
commented
Apr 26, 2022

Copy link


Copy Markdown

Collaborator
You'll need to rebase onto main (dropping the first commit)
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
30d5d73 to
7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml
Outdated

 x-kubernetes-int-or-string: true
 description: 'StorageClassSize defines an optional map of sizes
 of persistent volume claims for each storage class used by DevWorkspaces.
 The available keys to the map are: "common", "per-workspace".
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P
@amisevskamisevskApr 27, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use
make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.
I also made sure that any other workspace I had (other than che-server) was deleted.
It says 545.4 MiB were used:
image
@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-code and built it on the dog fooding cluster.
After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.

After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)

After running yarn build, disk usage is 3.39GiB.

Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image
amisevsk
amisevsk
reviewed
Apr 28, 2022
View reviewed changes
@amisevskamisevsk
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).
@amisevsk
amisevsk
commented
Apr 28, 2022

Copy link


Copy Markdown

Collaborator
I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow
requested a review
from amisevskApril 29, 2022 16:53
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
May 2, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Not sure yet why the check sources CI is suddenly failing:
go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.
@amisevsk
amisevsk
commented
May 3, 2022

Copy link


Copy Markdown

Collaborator
#831 should fix PR check
@AObuchowAObuchow
changed the title
WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow
marked this pull request as ready for review
May 9, 2022 22:01
@AObuchow
AObuchow
requested a review
from ibuziuk
as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk
approved these changes
May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated


Comment on lines

+295
 to 
+298

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 11, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.
workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is
workspace.defaultStorageSize.perWorkspace


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 11, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace
@amisevskamisevskMay 12, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
276e56f to
9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 11, 2022
@AObuchow
AObuchow
requested a review
from amisevskMay 11, 2022 20:22

This was referenced May 13, 2022

Closed

 Merged

ibuziuk
ibuziuk
reviewed
May 18, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?
@AObuchow
AObuchow
commented
May 18, 2022

Copy link


Copy Markdown

CollaboratorAuthor
@AObuchow could you please resolve the conficts?
Sorry about that - will be done in a moment.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
57f4be1 to
c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow
requested a review
from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk
approved these changes
May 24, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
amisevsk
amisevsk
reviewed
May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 24, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 25, 2022
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
ae1cfd2 to
3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
3932e90 to
ac607dfCompareMay 25, 2022 14:36
@openshift-ci
openshift-ciBot
commented
May 25, 2022

Copy link


Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: amisevsk, AObuchow, ibuziuk
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Details
Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment

Approvers can cancel approval by writing /approve cancel in a comment
@amisevsk
amisevsk
commented
May 25, 2022

Copy link


Copy Markdown

Collaborator
/retest
@AObuchow
AObuchow
merged commit 9b9d8fd
into
devfile:mainMay 27, 2022
@amisevskamisevsk
mentioned this pull request
Jun 23, 2022

Open

@l0rdl0rd
mentioned this pull request
Jul 27, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk
@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)


3 participants

@AObuchow@amisevsk@ibuziuk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Configurable default PVC size for common and per-workspace storage classes by AObuchow · Pull Request #827 · devfile/devworkspace-operator · GitHub
Skip to content
Configurable default PVC size for common and per-workspace storage classes - #827
Merged
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged
Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
Conversation
@AObuchow
@AObuchowAObuchow
commented
Apr 26, 2022•

edited

Loading

Copy link


Copy Markdown

Collaborator
What does this PR do?
  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes
In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.
What issues does this PR fix or reference?
Fix#792.
Is it tested? How?
  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.

    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.
Additional WIP notes
  • Setting the storage class sizes with a CRD still needs to be manually tested
PR Checklist
  •  E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)

    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che
@openshift-ci
openshift-ciBot
requested a review
from amisevskApril 26, 2022 14:16
@openshift-ci
openshift-ciBot
commented
Apr 26, 2022

Copy link


Copy Markdown

Hi @AObuchow. Thanks for your PR.
I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Details
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
00bb54c to
30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk
reviewed
Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/defaults.go
Outdated

@amisevsk
amisevsk
commented
Apr 26, 2022

Copy link


Copy Markdown

Collaborator
You'll need to rebase onto main (dropping the first commit)
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
30d5d73 to
7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml
Outdated

 x-kubernetes-int-or-string: true
 description: 'StorageClassSize defines an optional map of sizes
 of persistent volume claims for each storage class used by DevWorkspaces.
 The available keys to the map are: "common", "per-workspace".
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P
@amisevskamisevskApr 27, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use
make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.
I also made sure that any other workspace I had (other than che-server) was deleted.
It says 545.4 MiB were used:
image
@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-code and built it on the dog fooding cluster.
After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.

After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)

After running yarn build, disk usage is 3.39GiB.

Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image
amisevsk
amisevsk
reviewed
Apr 28, 2022
View reviewed changes
@amisevskamisevsk
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).
@amisevsk
amisevsk
commented
Apr 28, 2022

Copy link


Copy Markdown

Collaborator
I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow
requested a review
from amisevskApril 29, 2022 16:53
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
May 2, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Not sure yet why the check sources CI is suddenly failing:
go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.
@amisevsk
amisevsk
commented
May 3, 2022

Copy link


Copy Markdown

Collaborator
#831 should fix PR check
@AObuchowAObuchow
changed the title
WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow
marked this pull request as ready for review
May 9, 2022 22:01
@AObuchow
AObuchow
requested a review
from ibuziuk
as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk
approved these changes
May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated


Comment on lines

+295
 to 
+298

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 11, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.
workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is
workspace.defaultStorageSize.perWorkspace


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 11, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace
@amisevskamisevskMay 12, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
276e56f to
9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 11, 2022
@AObuchow
AObuchow
requested a review
from amisevskMay 11, 2022 20:22

This was referenced May 13, 2022

Closed

 Merged

ibuziuk
ibuziuk
reviewed
May 18, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?
@AObuchow
AObuchow
commented
May 18, 2022

Copy link


Copy Markdown

CollaboratorAuthor
@AObuchow could you please resolve the conficts?
Sorry about that - will be done in a moment.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
57f4be1 to
c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow
requested a review
from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk
approved these changes
May 24, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
amisevsk
amisevsk
reviewed
May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 24, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 25, 2022
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
ae1cfd2 to
3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
3932e90 to
ac607dfCompareMay 25, 2022 14:36
@openshift-ci
openshift-ciBot
commented
May 25, 2022

Copy link


Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: amisevsk, AObuchow, ibuziuk
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Details
Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment

Approvers can cancel approval by writing /approve cancel in a comment
@amisevsk
amisevsk
commented
May 25, 2022

Copy link


Copy Markdown

Collaborator
/retest
@AObuchow
AObuchow
merged commit 9b9d8fd
into
devfile:mainMay 27, 2022
@amisevskamisevsk
mentioned this pull request
Jun 23, 2022

Open

@l0rdl0rd
mentioned this pull request
Jul 27, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk
@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)


3 participants

@AObuchow@amisevsk@ibuziuk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Configurable default PVC size for common and per-workspace storage classes by AObuchow · Pull Request #827 · devfile/devworkspace-operator · GitHub
Skip to content
Configurable default PVC size for common and per-workspace storage classes - #827
Merged
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged
Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
Conversation
@AObuchow
@AObuchowAObuchow
commented
Apr 26, 2022•

edited

Loading

Copy link


Copy Markdown

Collaborator
What does this PR do?
  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes
In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.
What issues does this PR fix or reference?
Fix#792.
Is it tested? How?
  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.

    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.
Additional WIP notes
  • Setting the storage class sizes with a CRD still needs to be manually tested
PR Checklist
  •  E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)

    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che
@openshift-ci
openshift-ciBot
requested a review
from amisevskApril 26, 2022 14:16
@openshift-ci
openshift-ciBot
commented
Apr 26, 2022

Copy link


Copy Markdown

Hi @AObuchow. Thanks for your PR.
I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Details
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
00bb54c to
30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk
reviewed
Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/defaults.go
Outdated

@amisevsk
amisevsk
commented
Apr 26, 2022

Copy link


Copy Markdown

Collaborator
You'll need to rebase onto main (dropping the first commit)
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
30d5d73 to
7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml
Outdated

 x-kubernetes-int-or-string: true
 description: 'StorageClassSize defines an optional map of sizes
 of persistent volume claims for each storage class used by DevWorkspaces.
 The available keys to the map are: "common", "per-workspace".
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P
@amisevskamisevskApr 27, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use
make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.
I also made sure that any other workspace I had (other than che-server) was deleted.
It says 545.4 MiB were used:
image
@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-code and built it on the dog fooding cluster.
After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.

After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)

After running yarn build, disk usage is 3.39GiB.

Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image
amisevsk
amisevsk
reviewed
Apr 28, 2022
View reviewed changes
@amisevskamisevsk
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).
@amisevsk
amisevsk
commented
Apr 28, 2022

Copy link


Copy Markdown

Collaborator
I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow
requested a review
from amisevskApril 29, 2022 16:53
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
May 2, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Not sure yet why the check sources CI is suddenly failing:
go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.
@amisevsk
amisevsk
commented
May 3, 2022

Copy link


Copy Markdown

Collaborator
#831 should fix PR check
@AObuchowAObuchow
changed the title
WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow
marked this pull request as ready for review
May 9, 2022 22:01
@AObuchow
AObuchow
requested a review
from ibuziuk
as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk
approved these changes
May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated


Comment on lines

+295
 to 
+298

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 11, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.
workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is
workspace.defaultStorageSize.perWorkspace


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 11, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace
@amisevskamisevskMay 12, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
276e56f to
9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 11, 2022
@AObuchow
AObuchow
requested a review
from amisevskMay 11, 2022 20:22

This was referenced May 13, 2022

Closed

 Merged

ibuziuk
ibuziuk
reviewed
May 18, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?
@AObuchow
AObuchow
commented
May 18, 2022

Copy link


Copy Markdown

CollaboratorAuthor
@AObuchow could you please resolve the conficts?
Sorry about that - will be done in a moment.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
57f4be1 to
c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow
requested a review
from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk
approved these changes
May 24, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
amisevsk
amisevsk
reviewed
May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 24, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 25, 2022
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
ae1cfd2 to
3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
3932e90 to
ac607dfCompareMay 25, 2022 14:36
@openshift-ci
openshift-ciBot
commented
May 25, 2022

Copy link


Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: amisevsk, AObuchow, ibuziuk
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Details
Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment

Approvers can cancel approval by writing /approve cancel in a comment
@amisevsk
amisevsk
commented
May 25, 2022

Copy link


Copy Markdown

Collaborator
/retest
@AObuchow
AObuchow
merged commit 9b9d8fd
into
devfile:mainMay 27, 2022
@amisevskamisevsk
mentioned this pull request
Jun 23, 2022

Open

@l0rdl0rd
mentioned this pull request
Jul 27, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk
@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)


3 participants

@AObuchow@amisevsk@ibuziuk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Configurable default PVC size for common and per-workspace storage classes by AObuchow · Pull Request #827 · devfile/devworkspace-operator · GitHub
Skip to content
Configurable default PVC size for common and per-workspace storage classes - #827
Merged
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged
Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
Conversation
@AObuchow
@AObuchowAObuchow
commented
Apr 26, 2022•

edited

Loading

Copy link


Copy Markdown

Collaborator
What does this PR do?
  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes
In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.
What issues does this PR fix or reference?
Fix#792.
Is it tested? How?
  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.

    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.
Additional WIP notes
  • Setting the storage class sizes with a CRD still needs to be manually tested
PR Checklist
  •  E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)

    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che
@openshift-ci
openshift-ciBot
requested a review
from amisevskApril 26, 2022 14:16
@openshift-ci
openshift-ciBot
commented
Apr 26, 2022

Copy link


Copy Markdown

Hi @AObuchow. Thanks for your PR.
I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Details
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
00bb54c to
30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk
reviewed
Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/defaults.go
Outdated

@amisevsk
amisevsk
commented
Apr 26, 2022

Copy link


Copy Markdown

Collaborator
You'll need to rebase onto main (dropping the first commit)
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
30d5d73 to
7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml
Outdated

 x-kubernetes-int-or-string: true
 description: 'StorageClassSize defines an optional map of sizes
 of persistent volume claims for each storage class used by DevWorkspaces.
 The available keys to the map are: "common", "per-workspace".
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P
@amisevskamisevskApr 27, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use
make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.
I also made sure that any other workspace I had (other than che-server) was deleted.
It says 545.4 MiB were used:
image
@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-code and built it on the dog fooding cluster.
After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.

After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)

After running yarn build, disk usage is 3.39GiB.

Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image
amisevsk
amisevsk
reviewed
Apr 28, 2022
View reviewed changes
@amisevskamisevsk
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).
@amisevsk
amisevsk
commented
Apr 28, 2022

Copy link


Copy Markdown

Collaborator
I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow
requested a review
from amisevskApril 29, 2022 16:53
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
May 2, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Not sure yet why the check sources CI is suddenly failing:
go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.
@amisevsk
amisevsk
commented
May 3, 2022

Copy link


Copy Markdown

Collaborator
#831 should fix PR check
@AObuchowAObuchow
changed the title
WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow
marked this pull request as ready for review
May 9, 2022 22:01
@AObuchow
AObuchow
requested a review
from ibuziuk
as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk
approved these changes
May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated


Comment on lines

+295
 to 
+298

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 11, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.
workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is
workspace.defaultStorageSize.perWorkspace


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 11, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace
@amisevskamisevskMay 12, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
276e56f to
9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 11, 2022
@AObuchow
AObuchow
requested a review
from amisevskMay 11, 2022 20:22

This was referenced May 13, 2022

Closed

 Merged

ibuziuk
ibuziuk
reviewed
May 18, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?
@AObuchow
AObuchow
commented
May 18, 2022

Copy link


Copy Markdown

CollaboratorAuthor
@AObuchow could you please resolve the conficts?
Sorry about that - will be done in a moment.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
57f4be1 to
c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow
requested a review
from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk
approved these changes
May 24, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
amisevsk
amisevsk
reviewed
May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 24, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 25, 2022
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
ae1cfd2 to
3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
3932e90 to
ac607dfCompareMay 25, 2022 14:36
@openshift-ci
openshift-ciBot
commented
May 25, 2022

Copy link


Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: amisevsk, AObuchow, ibuziuk
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Details
Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment

Approvers can cancel approval by writing /approve cancel in a comment
@amisevsk
amisevsk
commented
May 25, 2022

Copy link


Copy Markdown

Collaborator
/retest
@AObuchow
AObuchow
merged commit 9b9d8fd
into
devfile:mainMay 27, 2022
@amisevskamisevsk
mentioned this pull request
Jun 23, 2022

Open

@l0rdl0rd
mentioned this pull request
Jul 27, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk
@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)


3 participants

@AObuchow@amisevsk@ibuziuk

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Configurable default PVC size for common and per-workspace storage classes by AObuchow · Pull Request #827 · devfile/devworkspace-operator · GitHub
Skip to content
Configurable default PVC size for common and per-workspace storage classes - #827
Merged
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
May 27, 2022
Merged
Configurable default PVC size for common and per-workspace storage classes#827
AObuchow merged 3 commits into
devfile:mainfrom 
AObuchow:configurable_default_pvc_size
Conversation
@AObuchow
@AObuchowAObuchow
commented
Apr 26, 2022•

edited

Loading

Copy link


Copy Markdown

Collaborator
What does this PR do?
  • Allows for (optionally) configuring the default PVC size for common and per-workspace storage classes using DevWorkspaceOperatorConfig CRD
  • Sets default PVC sizes for common/async and per-workspace storage classes
In order to configure the default PVC size for a storage class, a DevWorkspaceOperatorConfig CRD must be applied to the cluster with the DefaultStorageSizeworkspace property set. This property takes a struct where the resource.Quantity fields define the PVC sizes for common/async and per-workspace storage classes.
What issues does this PR fix or reference?
Fix#792.
Is it tested? How?
  • Manual testing of PVC size defaults has been done by starting up a cluster, applying a devfile that uses the controller.devfile.io/storage-type attribute set to per-workspace and verifying the newly created PVC size is set to the default size for per-workspace storage.

    • Manually testing the default PVC size for common storage still needs to be done, however the "new" default is currently the same as it used to be (10Gi)
  • The commonStorage test has been modified to support this new change. Both the common and per-workspace storage class tests are passing with this new change.
  • The sync tests have been modified to support this new change.
Additional WIP notes
  • Setting the storage class sizes with a CRD still needs to be manually tested
PR Checklist
  •  E2E tests pass (when PR is ready, comment /test v8-devworkspace-operator-e2e, v8-che-happy-path to trigger)

    • v8-devworkspace-operator-e2e: DevWorkspace e2e test
    • v8-che-happy-path: Happy path for verification integration with Che
@openshift-ci
openshift-ciBot
requested a review
from amisevskApril 26, 2022 14:16
@openshift-ci
openshift-ciBot
commented
Apr 26, 2022

Copy link


Copy Markdown

Hi @AObuchow. Thanks for your PR.
I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.
Once the patch is verified, the new status will be reflected by the ok-to-test label.
I understand the commands that are listed here.
Details
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
00bb54c to
30d5d73CompareApril 26, 2022 14:25
amisevsk
amisevsk
reviewed
Apr 26, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/defaults.go
Outdated

@amisevsk
amisevsk
commented
Apr 26, 2022

Copy link


Copy Markdown

Collaborator
You'll need to rebase onto main (dropping the first commit)
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
30d5d73 to
7266ce6CompareApril 26, 2022 21:56
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threaddeploy/deployment/kubernetes/combined.yaml
Outdated

 x-kubernetes-int-or-string: true
 description: 'StorageClassSize defines an optional map of sizes
 of persistent volume claims for each storage class used by DevWorkspaces.
 The available keys to the map are: "common", "per-workspace".
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure why these files don't have the mention of async using the common storage class PVC size that I added?
@AObuchowAObuchowApr 26, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CI is also complaining about this :P
@amisevskamisevskApr 27, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to run make generate to regenerate CRDs after changing the go definition. I use
make generate manifests fmt generate_default_deployment generate_olm_bundle_yaml

to make sure all autogenerated files are in sync.
AObuchow
AObuchow
commented
Apr 26, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 27, 2022
View reviewed changes
Comment threadpkg/provision/storage/commonStorage_test.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadpkg/config/sync.go
Outdated

Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Outdated

Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 27, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-server and built it on the dog fooding cluster, then checked the workspace's associated PVC usage from the OpenShift dashboard.
I also made sure that any other workspace I had (other than che-server) was deleted.
It says 545.4 MiB were used:
image
@AObuchow
AObuchow
commented
Apr 28, 2022

Copy link


Copy Markdown

CollaboratorAuthor
I opened che-code and built it on the dog fooding cluster.
After initial workspace setup (git clone and plugins, which were automatically setup), disk usage was 981.3MiB.

After running yarn prepare, disk usage was just under 3GiB (2.7GiB IIRC)

After running yarn build, disk usage is 3.39GiB.

Finally, I ran yarn watch and in another terminal, yarn server which brought up the disk usage to 3.49GiB
image
amisevsk
amisevsk
reviewed
Apr 28, 2022
View reviewed changes
@amisevskamisevsk
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After some discussion with Andrew, we've decided that it makes more sense to define the default storage size configuration fields as a struct rather than map[string]string. This will allow for better documentation and easier validation (since we can rely on the k8s API).
@amisevsk
amisevsk
commented
Apr 28, 2022

Copy link


Copy Markdown

Collaborator
I'm 👍 on setting the default per-workspace storage size to 5Gi to be on the safe side (4Gi isn't much wiggle room for a project like che-code). One of the benefits of this PR is that these defaults become configurable, so we should aim for something that always works as a default, even if it overprovisions storage in most cases.
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
@AObuchow
AObuchow
requested a review
from amisevskApril 29, 2022 16:53
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

AObuchow
AObuchow
commented
Apr 29, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

amisevsk
amisevsk
reviewed
Apr 29, 2022
View reviewed changes
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadapis/controller/v1alpha1/devworkspaceoperatorconfig_types.go
Comment threadpkg/config/sync.go
Outdated

@AObuchow
AObuchow
commented
May 2, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Not sure yet why the check sources CI is suddenly failing:
go: downloading golang.org/x/sys v0.0.0-20220502124256-b6088ccd6cba
Error: ../../../go/pkg/mod/golang.org/x/tools@v0.1.10/cmd/goimports/goimports.go:14:2: //go:build comment without // +build comment
Error: Process completed with exit code 1.
@amisevsk
amisevsk
commented
May 3, 2022

Copy link


Copy Markdown

Collaborator
#831 should fix PR check
@AObuchowAObuchow
changed the title
WIP: Configurable default PVC size for common and per-workspace storage classesConfigurable default PVC size for common and per-workspace storage classesMay 4, 2022
@AObuchow
AObuchow
marked this pull request as ready for review
May 9, 2022 22:01
@AObuchow
AObuchow
requested a review
from ibuziuk
as a code ownerMay 9, 2022 22:01
amisevsk
amisevsk
approved these changes
May 11, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated


Comment on lines

+295
 to 
+298

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 11, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should hard-code the config names, this will result in logging e.g.
workspace.defaultStorageSize.per-workspace=5Gi

even though the actual config field is
workspace.defaultStorageSize.perWorkspace


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.CommonStorageClassType, Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.%s=%s", constants.PerWorkspaceStorageClassType, Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
ifWorkspace.DefaultStorageSize.PerWorkspace!=nil {
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 11, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, I went with per-workspace instead of perWorkspace. Let me know if you rather it be perWorkspace
@amisevskamisevskMay 12, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should match the actual field in the config though -- the dot delimited format is meaningful here. If you try to set workspace.defaultStorageSize.per-workspace in the DevWorkspaceOperatorConfig, it will be invalid.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
276e56f to
9a6e005CompareMay 11, 2022 20:21
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 11, 2022
@AObuchow
AObuchow
requested a review
from amisevskMay 11, 2022 20:22

This was referenced May 13, 2022

Closed

 Merged

ibuziuk
ibuziuk
reviewed
May 18, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AObuchow could you please resolve the conficts?
@AObuchow
AObuchow
commented
May 18, 2022

Copy link


Copy Markdown

CollaboratorAuthor
@AObuchow could you please resolve the conficts?
Sorry about that - will be done in a moment.
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
57f4be1 to
c2aa8d0CompareMay 18, 2022 15:02
@AObuchow
AObuchow
requested a review
from ibuziukMay 18, 2022 15:08
ibuziuk
ibuziuk
approved these changes
May 24, 2022
View reviewed changes
@ibuziukibuziuk
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍
amisevsk
amisevsk
reviewed
May 24, 2022
View reviewed changes
Comment threadpkg/config/sync.go
Outdated

 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.common=%s", Workspace.DefaultStorageSize.Common.String()))
 }
 if Workspace.DefaultStorageSize.PerWorkspace != nil {
 config = append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@amisevskamisevskMay 24, 2022

Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Suggested change

config=append(config, fmt.Sprintf("workspace.defaultStorageSize.per-workspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
config=append(config, fmt.Sprintf("workspace.defaultStorageSize.perWorkspace=%s", Workspace.DefaultStorageSize.PerWorkspace.String()))
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :) Will autosquash when ready for merge
@AObuchowAObuchowMay 25, 2022

Copy link


Copy Markdown

CollaboratorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good for merge assuming nothing else needs to be changed 😎
@openshift-ciopenshift-ciBot
removed
the 
lgtm

label
May 25, 2022
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
ae1cfd2 to
3932e90CompareMay 25, 2022 14:29
@AObuchow
feat: Configurable PVC size (fixdevfile#740)
c714b3a
Both common and per-workspace storage class PVC sizes can be configured through CRD's
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
Generate config. option for configurable PVC size
8c81e42
Part of devfile#740
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
feat: configmap option for perWorkspace PVC size
ac607df
Fixdevfile#836
Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
@AObuchow
AObuchowforce-pushed
the
configurable_default_pvc_size
branch
from
3932e90 to
ac607dfCompareMay 25, 2022 14:36
@openshift-ci
openshift-ciBot
commented
May 25, 2022

Copy link


Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: amisevsk, AObuchow, ibuziuk
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Details
Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment

Approvers can cancel approval by writing /approve cancel in a comment
@amisevsk
amisevsk
commented
May 25, 2022

Copy link


Copy Markdown

Collaborator
/retest
@AObuchow
AObuchow
merged commit 9b9d8fd
into
devfile:mainMay 27, 2022
@amisevskamisevsk
mentioned this pull request
Jun 23, 2022

Open

@l0rdl0rd
mentioned this pull request
Jul 27, 2022

Open

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@ibuziukibuziukibuziuk approved these changes
@amisevskamisevskamisevsk approved these changes

Assignees

@ibuziukibuziuk
@amisevskamisevsk

Labels

approvedlgtmneeds-ok-to-test

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Support 'per-workspace' storage-class (one PVC per workspace)


3 participants

@AObuchow@amisevsk@ibuziuk