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 outdated README file and add development notes #553

Merged
merged 75 commits into from
Dec 1, 2020
Merged
Show file tree
Hide file tree
Changes from 73 commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
0c200ce
Fix outdated README file. Add more useful developement info.
AndrienkoAleksandr Nov 24, 2020
032da5c
Move some docs to the root README.md
AndrienkoAleksandr Nov 25, 2020
2fa3fae
Add more development info. Improve docs structure.
AndrienkoAleksandr Nov 25, 2020
a750f13
Fix some todos.
AndrienkoAleksandr Nov 25, 2020
af565e4
Fix up.
AndrienkoAleksandr Nov 25, 2020
8f4f6b8
Fix up.
AndrienkoAleksandr Nov 25, 2020
96d3240
Improve docs
AndrienkoAleksandr Nov 26, 2020
32ff9d6
Document che operator test cases
flacatus Nov 26, 2020
1888adb
Update .ci/README.md
tolusha Nov 26, 2020
5a61c4c
Update .ci/README.md
tolusha Nov 26, 2020
ed61dd2
Update .ci/README.md
tolusha Nov 26, 2020
f4505f4
Update .ci/README.md
tolusha Nov 26, 2020
ee4a888
Update .ci/README.md
tolusha Nov 26, 2020
1c4c4d1
Update .ci/README.md
tolusha Nov 26, 2020
e35ff62
Update .ci/README.md
tolusha Nov 26, 2020
56ffd59
Update .ci/README.md
tolusha Nov 26, 2020
6296171
Update .ci/README.md
tolusha Nov 26, 2020
d7d98c5
Update .ci/README.md
tolusha Nov 26, 2020
ab87950
Update .ci/README.md
tolusha Nov 26, 2020
2b50530
Update olm/README.md
tolusha Nov 26, 2020
2643b78
Update olm/README.md
tolusha Nov 26, 2020
4330710
Update olm/README.md
tolusha Nov 26, 2020
ed01b14
Update olm/README.md
tolusha Nov 26, 2020
4d13041
Update olm/README.md
tolusha Nov 26, 2020
5cb129a
Update olm/README.md
tolusha Nov 26, 2020
fdf8448
Update olm/README.md
tolusha Nov 26, 2020
41e5c29
Update olm/README.md
tolusha Nov 26, 2020
2c986b3
Update olm/README.md
tolusha Nov 26, 2020
5aa19dc
Update olm/README.md
tolusha Nov 26, 2020
c6fbc6f
Update olm/README.md
tolusha Nov 26, 2020
25a6f56
Update olm/README.md
tolusha Nov 26, 2020
24162d4
Update olm/README.md
tolusha Nov 26, 2020
ef3ccca
Update olm/README.md
tolusha Nov 26, 2020
30ea91f
Update olm/README.md
tolusha Nov 26, 2020
8715b60
Update olm/README.md
tolusha Nov 26, 2020
6595d2a
Update olm/README.md
tolusha Nov 26, 2020
b0c1bca
Update olm/README.md
tolusha Nov 26, 2020
9ac0a8d
Update olm/README.md
tolusha Nov 26, 2020
d438292
Update README.md
AndrienkoAleksandr Nov 27, 2020
7587f8f
Update README.md
AndrienkoAleksandr Nov 27, 2020
bb5d28e
Update README.md
AndrienkoAleksandr Nov 27, 2020
40f5bd6
Update README.md
AndrienkoAleksandr Nov 27, 2020
9b5047d
Update README.md
AndrienkoAleksandr Nov 27, 2020
c9784b2
Update README.md
AndrienkoAleksandr Nov 27, 2020
4ffe30b
Update README.md
AndrienkoAleksandr Nov 27, 2020
d9c2c8b
Update README.md
AndrienkoAleksandr Nov 27, 2020
9cc3359
Update README.md
AndrienkoAleksandr Nov 27, 2020
d1e4a0a
Update README.md
AndrienkoAleksandr Nov 27, 2020
6743a4f
Update README.md
AndrienkoAleksandr Nov 27, 2020
2f8979b
Update README.md
AndrienkoAleksandr Nov 27, 2020
f95ac43
Update README.md
AndrienkoAleksandr Nov 27, 2020
5575833
Update README.md
AndrienkoAleksandr Nov 27, 2020
5b21b49
Update README.md
AndrienkoAleksandr Nov 27, 2020
c8cc34f
Update README.md
AndrienkoAleksandr Nov 27, 2020
3df2634
Update README.md
AndrienkoAleksandr Nov 27, 2020
c04e155
Update README.md
AndrienkoAleksandr Nov 27, 2020
aba78be
Update README.md
AndrienkoAleksandr Nov 27, 2020
849ec77
Update README.md
AndrienkoAleksandr Nov 27, 2020
e6095e8
Update README.md
AndrienkoAleksandr Nov 27, 2020
73059db
Update README.md
AndrienkoAleksandr Nov 27, 2020
72fd2aa
Update README.md
AndrienkoAleksandr Nov 27, 2020
4cc58f5
Update README.md
AndrienkoAleksandr Nov 27, 2020
7b3770c
Update README.md
AndrienkoAleksandr Nov 27, 2020
3735e34
Update README.md
AndrienkoAleksandr Nov 27, 2020
fe26a18
Update README.md
AndrienkoAleksandr Nov 27, 2020
188fcfe
Update README.md
AndrienkoAleksandr Nov 27, 2020
1fa1f84
Update README.md
AndrienkoAleksandr Nov 27, 2020
e0fded6
Update README.md
AndrienkoAleksandr Nov 27, 2020
82a8f93
Update README.md
AndrienkoAleksandr Nov 27, 2020
19da16a
Update README.md
AndrienkoAleksandr Nov 27, 2020
65f8130
Update README.md
AndrienkoAleksandr Nov 27, 2020
44e5651
Apply suggestions from code review
AndrienkoAleksandr Nov 27, 2020
8ddd7da
Merge branch 'master' of github.com:eclipse/che-operator into fixOutD…
AndrienkoAleksandr Nov 27, 2020
bf99bc9
Refactoring README files
tolusha Dec 1, 2020
2dd4cb8
Small remarks
tolusha Dec 1, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .ci/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
### Che-Operator CI
Che Operator currently support two CI launch cases for Pull Request checks:
Copy link
Contributor

Choose a reason for hiding this comment

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

launch cases -> flows

- [Github Actions](https://github.com/eclipse/che-operator/actions)
- [Openshift CI](https://prow.ci.openshift.org/?job=*che*operator*)

#### Openshift CI

Openshift is a Kubernetes based CI/CD system. Jobs can be triggered by various types of events and report their status to many different services. In addition to job execution, Openshift CI provides GitHub automation in the form of policy enforcement, chat-ops via /foo style commands, and automatic PR merging.

All documentation about how to onboard components in Openshift CI can be found in the Openshift CI jobs [repository](https://github.com/openshift/release). One of the requirements to make changes in Openshift CI jobs is being an openshift GitHub member.

All che-operator jobs configurations are defined in `https://github.com/openshift/release/tree/master/ci-operator/config/eclipse/che-operator`.

###### Jobs
- Eclipse Che Updates. This job basically installs the latest official Eclipse Che release and then update Che to the new release detected in PR. Note this PR check runs against `main` branch and all 7.* branches.
- Eclipse Che Nightly OLM files. A job that deploys Eclipse Che nightly using the latest version.

All Openshift CI checks name in pull request have a special nomenclature. Example: ci/prow/v3-che-operator-update where: `v3` is Openshift4 version and `che-operator-update` is the name of the job.

###### Triggers
All available plugins to trigger in GitHub Pull Request can be found [here](https://github.com/openshift/release/blob/master/core-services/prow/02_config/_plugins.yaml#L3607). The most important plugin is `test ?`, this trigger displays all the available triggers in the PR.
In case of a job failure openshift-robot writes a comment about how to trigger a job which fails.

#### Github Actions

GitHub Actions is an API for cause and effect on GitHub: orchestrate any workflow, based on any event, while GitHub manages the execution, provides rich feedback, and secures every step along the way.

All che operator actions are defined in the `.github/workflows` yamls. Scripts are located in `.github/action_scripts` folder.

###### Jobs
For minikube we currently have:
- Eclipse Che Updates. This job basically installs the last official Eclipse Che release and then update Che to the new release detected in PR. Note this PR check runs against `main` branch and all 7.* branches.
- Eclipse Che Nightly OLM files. A job that deploys Eclipse Che nightly using the latest version.
- Eclipse Che Single host mode. Deploy Eclipse Che in single-host mode (native and gateway) and verify the workspaces startups.

For Minishift we currently have:
- Eclipse Che Update
- Deploy Eclipse Che nightly

###### Triggers
To relaunch failed GitHub action checks you have to use GitHub UI(`Re-run jobs` button). Note the button executes the whole workflow.
42 changes: 39 additions & 3 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,47 @@
"version": "2.0.0",
"tasks": [
{
"label": "Update vendor folder",
"label": "Compile che-operator code",
"command": "GOOS=linux GOARCH=${ARCH} CGO_ENABLED=0 go build -mod=vendor -o /tmp/che-operator/che-operator cmd/manager/main.go",
"options": {
"env": {
"ARCH": "amd64"
}
},
"type": "shell",
"args": [],
"problemMatcher": [
"$go"
],
"presentation": {
"reveal": "always"
},
"group": "build"
},
{
"label": "Format che-operator code",
"command": "go fmt ./...",
"options": {
"env": {
"ARCH": "amd64"
}
},
"type": "shell",
"args": [],
"problemMatcher": [
"$go"
],
"presentation": {
"reveal": "always"
},
"group": "build"
},
{
"label": "Update che-operator dependencies",
"command": "go mod vendor",
"options": {
"env": {
"MOCK_API": "true"
"ARCH": "amd64"
}
},
"type": "shell",
Expand All @@ -20,7 +56,7 @@
"group": "build"
},
{
"label": "Run mock tests",
"label": "Run che-operator mock tests",
"command": "go test -mod=vendor -v ./...",
"options": {
"env": {
Expand Down
Loading