Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

fix: Update article to configure a user namespace #2807

Merged
merged 4 commits into from
Nov 6, 2024
Merged

fix: Update article to configure a user namespace #2807

merged 4 commits into from
Nov 6, 2024

Conversation

tolusha
Copy link
Contributor

@tolusha tolusha commented Oct 25, 2024

What does this pull request change?

fix: Update article to configure a user namespace

What issues does this pull request fix or reference?

eclipse-che/che#23176

Specify the version of the product this pull request applies to

main

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@tolusha tolusha requested review from deerskindoll and a team as code owners October 25, 2024 08:43
@tolusha tolusha requested a review from l0rd October 25, 2024 08:43
Copy link

github-actions bot commented Oct 25, 2024

Click here to review and test in web IDE: Contribute

Copy link

github-actions bot commented Oct 25, 2024

🎊 Navigate the preview: 🎊

Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

lgtm

@tolusha tolusha marked this pull request as draft October 28, 2024 11:33
@tolusha tolusha requested a review from deerskindoll October 29, 2024 13:08
@tolusha tolusha marked this pull request as ready for review October 29, 2024 13:08
Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

Vale error fix. the pipeline should succeed with these changes.

Comment on lines 191 to 193
parameters:
- name: PROJECT_NAME
- name: PROJECT_{prod-short}_USER
Copy link
Member

Choose a reason for hiding this comment

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

@tolusha I do not quite understand why do we need extra parameters? Could you clarify the use-case for that?
The original idea was just to do oc process / oc apply of the template for all user's namespaces

Copy link
Contributor Author

Choose a reason for hiding this comment

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

oc process doesn't allow to keep updates up to date if Template has been changed.
We need manually create objects, watch for changes and update if needed

Signed-off-by: Anatolii Bazko <abazko@redhat.com>
Comment on lines 191 to 201
parameters:
- name: PROJECT_NAME
- name: PROJECT_ADMIN_USER

----
+
The `objects` array can contain any number of resources, including the previously mentioned ConfigMaps, Secrets, and PersistentVolumeClaims.
+
The `parameters` are optional and define which parameters can be used. Currently, only `PROJECT_NAME` and `PROJECT_ADMIN_USER` are supported. `PROJECT_NAME` is the name of the {prod-short} {namespace}, while `PROJECT_ADMIN_USER` is the {prod-short} user of the {namespace}.
+
The {namespace} name in objects is omitted and replaced with the user's {namespace} name during synchronization.
Copy link
Member

Choose a reason for hiding this comment

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

if we want to promote those parameters in Eclipse Che docs we need to cross-link it with OpenShift docs.
I do not see any references in https://docs.openshift.com/container-platform/4.17/rest_api/template_apis/template-template-openshift-io-v1.html

Signed-off-by: Anatolii Bazko <abazko@redhat.com>
@ibuziuk
Copy link
Member

ibuziuk commented Nov 4, 2024

@deerskindoll do you happen to know why the preview URL is not working? #2807 (comment)

@deerskindoll
Copy link
Contributor

@deerskindoll do you happen to know why the preview URL is not working? #2807 (comment)

@ibuziuk I suspect it's because of the failed pipelines. @mkuznyetsov what do you think? can you please have a look? the asciidoctor issue was reported to the Vale support group but it didn't affect the other pipelines previously.

@deerskindoll
Copy link
Contributor

update: running preview from a che workspace works. no idea why the preview isn't generated in the PR itself.

Copy link
Member

@ibuziuk ibuziuk left a comment

Choose a reason for hiding this comment

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

👍

Signed-off-by: Anatolii Bazko <abazko@redhat.com>
…e.adoc

Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
@tolusha tolusha merged commit 7437917 into main Nov 6, 2024
8 of 10 checks passed
@tolusha tolusha deleted the 23176 branch November 6, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants