Fix outdated README file and add development notes #553

AndrienkoAleksandr · 2020-11-24T21:38:51Z

What does this pr do:

Fix outdated info. Add more development info: how to debug che-operator, how to check che-operator compilation, info about CR/CRD and when should be updated Olm bundle, how to add new role/cluster role, how to use chectl to test che-operator and more.

Referenced issue:

eclipse-che/che#18295

Signed-off-by: Oleksandr Andriienko oandriie@redhat.com

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

openshift-ci-robot · 2020-11-24T21:39:03Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

.vscode/tasks.json

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

Signed-off-by: Flavius Lacatusu <flacatus@redhat.com>

.ci/README.md

olm/README.md

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

…atedREADMEFile

mmorhun

Good job!

mmorhun · 2020-11-27T13:40:45Z

.ci/README.md

@@ -0,0 +1,41 @@
+### Che-Operator CI
+Che Operator currently support two CI launch cases for Pull Request checks:


launch cases -> flows

mmorhun · 2020-11-30T10:20:24Z

README.md

+You can also modify Kubernetes objects using the terminal.
+You can edit checluster CR object using the command-line editor: 


What is the difference between these two?

mmorhun · 2020-11-30T10:25:23Z

README.md

 If cluster router uses certificate signed by self-signed one, then parent/root CA certificate should be added into corresponding config map of additional trusted certificates (see `serverTrustStoreConfigMapName` option).

 #### K8S

 By default self-signed certificates for Che will be generated automatically.
-If it is needed to use own certificates, create `che-tls` secret (see `k8s.tlsSecretName` option) with `key.crt` and `tls.crt` fields. In case of self-signed certificate `self-signed-certificate` secret should be created with public part of CA certificate under `ca.crt` key in secret data.
+If it is needed to use your own certificates, create `che-tls` secret (see `k8s.tlsSecretName` option) with `key.crt` and `tls.crt` fields. In case of self-signed certificate `self-signed-certificate` secret should be created with the public part of CA certificate under `ca.crt` key in secret data.


Here we can add a note, that is is possible to use default certificate of Kubernetes cluster by passing empty string as a value of tlsSecretName:

spec: k8s: tlsSecretName: ''

openshift-ci-robot · 2020-11-30T10:37:59Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: AndrienkoAleksandr, mmorhun
To complete the pull request process, please assign after the PR has been reviewed.
You can assign the PR to them by writing /assign in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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

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

openshift-ci-robot · 2020-12-01T08:47:28Z

New changes are detected. LGTM label has been removed.

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

openshift-merge-robot · 2020-12-01T10:25:04Z

@AndrienkoAleksandr: The following test failed, say /retest to rerun all failed tests:

Test name	Commit	Details	Rerun command
ci/prow/v4-che-operator-update	`2dd4cb8`	link	`/test v4-che-operator-update`

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

Fix outdated README file. Add more useful developement info.

0c200ce

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

openshift-ci-robot added the do-not-merge/work-in-progress label Nov 24, 2020

AndrienkoAleksandr requested a review from tolusha November 24, 2020 21:39

tolusha mentioned this pull request Nov 25, 2020

Che Deploy Sprint #193 eclipse-che/che#18375

Closed

58 tasks

AndrienkoAleksandr added 2 commits November 25, 2020 11:05

Move some docs to the root README.md

032da5c

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

Add more development info. Improve docs structure.

2fa3fae

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

tolusha reviewed Nov 25, 2020

View reviewed changes

.vscode/tasks.json Outdated Show resolved Hide resolved

.vscode/tasks.json Outdated Show resolved Hide resolved

AndrienkoAleksandr added 4 commits November 25, 2020 23:30

Fix some todos.

a750f13

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

Fix up.

af565e4

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

Fix up.

8f4f6b8

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

Improve docs

96d3240

Signed-off-by: Oleksandr Andriienko <oandriie@redhat.com>

AndrienkoAleksandr marked this pull request as ready for review November 26, 2020 08:43

AndrienkoAleksandr requested review from davidfestal and nickboldt as code owners November 26, 2020 08:43

openshift-ci-robot removed the do-not-merge/work-in-progress label Nov 26, 2020

AndrienkoAleksandr requested review from mmorhun and flacatus November 26, 2020 08:43

Document che operator test cases

32ff9d6

Signed-off-by: Flavius Lacatusu <flacatus@redhat.com>

yhontyk reviewed Nov 26, 2020

View reviewed changes

tolusha and others added 2 commits November 26, 2020 17:12

Update .ci/README.md

1888adb

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update .ci/README.md

5a61c4c

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

openshift-ci-robot added the needs-rebase label Nov 26, 2020

tolusha and others added 7 commits November 26, 2020 17:12

Update .ci/README.md

ed61dd2

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update .ci/README.md

f4505f4

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update .ci/README.md

ee4a888

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update .ci/README.md

1c4c4d1

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update .ci/README.md

e35ff62

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update .ci/README.md

56ffd59

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update .ci/README.md

6296171

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

AndrienkoAleksandr and others added 14 commits November 27, 2020 12:22

Update README.md

73059db

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

72fd2aa

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

4cc58f5

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

7b3770c

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

3735e34

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

fe26a18

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

188fcfe

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

1fa1f84

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

e0fded6

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

82a8f93

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

19da16a

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Update README.md

65f8130

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Apply suggestions from code review

44e5651

Co-authored-by: Yana Hontyk <yhontyk@redhat.com>

Merge branch 'master' of github.com:eclipse/che-operator into fixOutD…

8ddd7da

…atedREADMEFile

openshift-ci-robot removed the needs-rebase label Nov 27, 2020

mmorhun approved these changes Nov 30, 2020

View reviewed changes

openshift-ci-robot assigned mmorhun Nov 30, 2020

openshift-ci-robot added the lgtm label Nov 30, 2020

mmorhun removed their assignment Nov 30, 2020

Refactoring README files

bf99bc9

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

openshift-ci-robot removed the lgtm label Dec 1, 2020

tolusha changed the title ~~Fix outdated README file. Add more useful developement info.~~ Fix outdated README file and add development notes Dec 1, 2020

Small remarks

2dd4cb8

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

tolusha closed this Dec 1, 2020

tolusha reopened this Dec 1, 2020

tolusha merged commit 8b4a5e0 into master Dec 1, 2020

tolusha deleted the fixOutDatedREADMEFile branch December 1, 2020 12:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix outdated README file and add development notes #553

Fix outdated README file and add development notes #553

AndrienkoAleksandr commented Nov 24, 2020

openshift-ci-robot commented Nov 24, 2020

mmorhun left a comment

mmorhun Nov 27, 2020

mmorhun Nov 30, 2020

mmorhun Nov 30, 2020

openshift-ci-robot commented Nov 30, 2020

openshift-ci-robot commented Dec 1, 2020

openshift-merge-robot commented Dec 1, 2020 •

edited

Loading

		@@ -0,0 +1,41 @@
		### Che-Operator CI
		Che Operator currently support two CI launch cases for Pull Request checks:

		You can also modify Kubernetes objects using the terminal.
		You can edit checluster CR object using the command-line editor:

Fix outdated README file and add development notes #553

Fix outdated README file and add development notes #553

Conversation

AndrienkoAleksandr commented Nov 24, 2020

What does this pr do:

Referenced issue:

openshift-ci-robot commented Nov 24, 2020

mmorhun left a comment

Choose a reason for hiding this comment

mmorhun Nov 27, 2020

Choose a reason for hiding this comment

mmorhun Nov 30, 2020

Choose a reason for hiding this comment

mmorhun Nov 30, 2020

Choose a reason for hiding this comment

openshift-ci-robot commented Nov 30, 2020

openshift-ci-robot commented Dec 1, 2020

openshift-merge-robot commented Dec 1, 2020 • edited Loading

openshift-merge-robot commented Dec 1, 2020 •

edited

Loading