-
Notifications
You must be signed in to change notification settings - Fork 165
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
Conversation
🎊 Navigate the preview: 🎊 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this 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.
modules/administration-guide/pages/configuring-a-user-namespace.adoc
Outdated
Show resolved
Hide resolved
modules/administration-guide/pages/configuring-a-user-namespace.adoc
Outdated
Show resolved
Hide resolved
parameters: | ||
- name: PROJECT_NAME | ||
- name: PROJECT_{prod-short}_USER |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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>
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. |
There was a problem hiding this comment.
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
@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. |
update: running preview from a che workspace works. no idea why the preview isn't generated in the PR itself. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
modules/administration-guide/pages/configuring-a-user-namespace.adoc
Outdated
Show resolved
Hide resolved
…e.adoc Co-authored-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
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.
Validate language on files added or modified
step reports no vale warnings.