Property descriptions #19233
Merged
Property descriptions #19233
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: xbaran4 <pbaran@redhat.com>
Signed-off-by: xbaran4 <pbaran@redhat.com>
xbaran4
requested review from
yhontyk,
ibuziuk,
MichalMaler,
nickboldt,
sleshchenko and
themr0c
as code owners
|
Can one of the admins verify this patch? |
che-bot
added
status/code-review
sparkoo
reviewed
Mar 9, 2021
assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/che.properties
Show resolved
Hide resolved
| che.oauth.github.clientid=NULL | ||
|
|
||
| # Your GitHub OAuth client secret. |
There was a problem hiding this comment.
Suggested change
| # Your GitHub OAuth client secret. | |
| # GitHub OAuth client secret. |
| # You can setup GitHub OAuth to automate authentication to remote repositories. | ||
| # You need to first register this application with GitHub OAuth. | ||
| # Your GitHub OAuth client ID. |
There was a problem hiding this comment.
Suggested change
| # Your GitHub OAuth client ID. | |
| # GitHub OAuth client ID. |
| che.infra.kubernetes.master_url= | ||
|
|
||
| # Configuration of Kubernetes client `whether to use trusted certificates` that Infra will use. |
There was a problem hiding this comment.
This description feels a bit clumsy. Why "whether to use trusted certificates
" is in a quotes?
What is the value type?
I see it's boolean, so without any value here it defaults to false? Maybe we should write false here explicitly.
| # Data for TLS Secret that should be used for workspaces Ingresses | ||
| # cert and key should be encoded with Base64 algorithm | ||
| # These properties are ignored by OpenShift infrastructure | ||
| # Key for TLS Secret that should be used for workspaces Ingresses |
There was a problem hiding this comment.
please write explicitly here that it is key data
| che.infra.kubernetes.tls_key=NULL | ||
|
|
||
| # Certificate for TLS Secret that should be used for workspaces Ingresses |
There was a problem hiding this comment.
Suggested change
| # Certificate for TLS Secret that should be used for workspaces Ingresses | |
| # Certificate for TLS Secret that should be used for workspaces Ingresses. |
| # plugins dependencies to a workspace | ||
| # | ||
| # Note these images are overridden by the Che Operator by default; changing the images here will not | ||
| # Docker image of plugin broker metadata. |
There was a problem hiding this comment.
I think "plugin metadata broker" would fit better
| # have an effect if Che is installed via Operator. | ||
| che.workspace.plugin_broker.metadata.image=quay.io/eclipse/che-plugin-metadata-broker:v3.4.0 | ||
|
|
||
| # Docker image of Che plugin broker artifacts. |
| # This broker runs as an init container on the workspace pod. Its job is to take in a list of plugin identifiers | ||
| # (either references to a plugin in the registry or a link to a plugin meta.yaml) and ensure that the correct .vsix | ||
| # and .theia extenions are downloaded into the /plugins directory, for each plugin requested for the workspace. | ||
| # Note this image is overridden by the Che Operator by default; changing the image here will not |
There was a problem hiding this comment.
I don't think we need to write here "changing the image here will not have an effect if Che is installed via Operator.". It's implicit for all values set externally with env variables.
| # which doesn't contain any Che-specific workspace descriptor. | ||
| che.factory.default_editor=eclipse/che-theia/next | ||
|
|
||
| # Plugins t will be used for factories which are created from remote git repository |
Signed-off-by: xbaran4 <pbaran@redhat.com>
Signed-off-by: xbaran4 <pbaran@redhat.com>
sparkoo
approved these changes
Mar 10, 2021
metlos
approved these changes
Mar 10, 2021
che-bot
removed
the
status/code-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: xbaran4 pbaran@redhat.com
What does this PR do?
Adds description to properties missing it.
Screenshot/screencast of this PR
What issues does this PR fix or reference?
#18572
How to test this PR?
Build and deploy on minikube with chectl.
PR Checklist
As the author of this Pull Request I made sure that:
What issues does this PR fix or referenceandHow to test this PRcompletedReviewers
Reviewers, please comment how you tested the PR when approving it.