Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rgolangh/github-issue-controller
A repo for an example k8s controller that creates issues
https://github.com/rgolangh/github-issue-controller
Last synced: 14 days ago
JSON representation
A repo for an example k8s controller that creates issues
- Host: GitHub
- URL: https://github.com/rgolangh/github-issue-controller
- Owner: rgolangh
- License: mit
- Created: 2021-04-19T13:08:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T06:29:28.000Z (2 months ago)
- Last Synced: 2024-11-01T07:23:35.945Z (2 months ago)
- Size: 1.95 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-issue-controller
A repo for an example k8s controller that creates issues
# how to work with this repo
[ ] clone this repo
[ ] generate a kubernetes controller using the operator-sdk https://sdk.operatorframework.io/docs/building-operators/golang/quickstart/
[ ] regulary push your work to your fork
[ ] use this repo to create issue from the controller you created. (contact me for the api token)
# controller creation chcek list
Using the operator SDK you created a Custom Resource that the controller watches. Its properties should be:
1. The `kind` should be something like `GitHubIssue`
2. The version should be `v1alpha1`
3. The specification or the so called `Spec` of the object should allow to define
- the owner/repo of the repo. In our case the value should be `rgolangh/github-issue-controller`.
- a title for the issue
- a description for the issue
4. The status of the real github issue in github.com should be saved to `Status`. Those properties are expected:
- the status of the issue (like 'closed', 'open')
- the full url of the issue (i.e https://github.com/some/repo/issues/1)
# controller reconciliation behaviour
- fetch the k8s github object by the req.NamespacedName:
- If it doesn't exist (error 404 or NotExist) - return with nil error. Any other error shall be returned.
- fetch all the github issues of the repository. Find one with the exact title you need.
- If it doesn't exist -> create a github issue with the title and description.
- If it exists -> update the description (if needed).
- update the k8s status with the real github issue state.
```mermaid
graph TD
A[Fetch K8s GitHub Object by req.NamespacedName]
B{Does it exist?}
C[Return with nil error]
D[Return error]
E[Fetch all GitHub Issues of the Repository]
F{Issue with the Title Exists?}
G[Create GitHub Issue with Title and Description]
H[Update Description if neeeded]
I[Update K8s Status with Real GitHub Issue State]
A --> B
B -- "No (Error 404 or NotExist)" --> C
B -- "Other Error" --> D
B -- "Yes" --> E
E --> F
F -- "No" --> G
F -- "Yes" --> H
G --> I
H --> I
```