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.

Sign up for GitHub

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

Jump to bottom

Missing api for managing Github Enterprise Server #3415

Open
s4mur4i opened this issue Jan 6, 2025 · 4 comments · May be fixed by #3433
Open

Missing api for managing Github Enterprise Server #3415

s4mur4i opened this issue Jan 6, 2025 · 4 comments · May be fixed by #3433
Assignees
@s4mur4i
Labels
enhancement go Pull requests that update Go code good first issue

Comments

@s4mur4i
Copy link

s4mur4i commented Jan 6, 2025

In GHES version 3.15 they added a new API for managing GHES servers. Release notes can be found here:
https://docs.github.com/en/[email protected]/admin/release-notes#3.15.0-retired
Searching repository i could not find any mention of this API
https://docs.github.com/en/[email protected]/rest/enterprise-admin/manage-ghes?apiVersion=2022-11-28#about-the-manage-github-enterprise-server-api

Why is this required
We have a small exporter for prometheus running on GHES node to expose metrics about services, and alert us for possible failures or errors.
With new API:
https://docs.github.com/en/[email protected]/rest/enterprise-admin/manage-ghes?apiVersion=2022-11-28#get-the-status-of-services-running-on-all-cluster-nodes
we can run this off host, which will also make upgrades easier, since we don't need to copy binary and do firewall/systemd changes for it.
@s4mur4i s4mur4i marked this as a duplicate of #3413 Jan 6, 2025
@s4mur4i s4mur4i marked this as a duplicate of #3414 Jan 6, 2025
@gmlewis gmlewis added enhancement good first issue go Pull requests that update Go code labels Jan 6, 2025
@gmlewis
Copy link
Collaborator

gmlewis commented Jan 6, 2025

Specifically, I believe this issue refers to the following endpoints:

$ rg /manage/
openapi_operations.yaml
1013:  - name: DELETE /manage/v1/access/ssh
1017:  - name: GET /manage/v1/access/ssh
1021:  - name: POST /manage/v1/access/ssh
1025:  - name: GET /manage/v1/checks/system-requirements
1029:  - name: GET /manage/v1/cluster/status
1033:  - name: GET /manage/v1/config/apply
1037:  - name: POST /manage/v1/config/apply
1041:  - name: GET /manage/v1/config/apply/events
1045:  - name: POST /manage/v1/config/init
1049:  - name: GET /manage/v1/config/license
1053:  - name: PUT /manage/v1/config/license
1057:  - name: GET /manage/v1/config/license/check
1061:  - name: GET /manage/v1/config/nodes
1065:  - name: GET /manage/v1/config/settings
1069:  - name: PUT /manage/v1/config/settings
1073:  - name: GET /manage/v1/maintenance
1077:  - name: POST /manage/v1/maintenance
1081:  - name: GET /manage/v1/replication/status
1085:  - name: GET /manage/v1/version

@gmlewis
Copy link
Collaborator

gmlewis commented Jan 6, 2025

This would be a great PR for any new contributor to this repo or a new Go developer.
All contributions are greatly appreciated!

Feel free to volunteer for any issue and the issue can be assigned to you so that others don't attempt to duplicate the work.
Also feel free to perform a code review on any PR that has the label "NeedsReview" - we appreciate those contributions too!

Please check out our CONTRIBUTING.md guide to get started. (In particular, please remember to go generate ./... and don't use force-push to your PRs.)

Thank you!

@s4mur4i
Copy link
Author

s4mur4i commented Jan 6, 2025

Yes, correct, thats a full list of the endpoints
Working on possible PR for them, according to CONTRIBUTION.md opened issue first to notify others of intent.

@s4mur4i s4mur4i linked a pull request Jan 15, 2025 that will close this issue
Open
@s4mur4i
Copy link
Author

s4mur4i commented Jan 15, 2025

Opened the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@s4mur4i s4mur4i

Labels
enhancement go Pull requests that update Go code good first issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Add manage_ghes endpoints introduced in 3.15 s4mur4i/go-github
2 participants
@s4mur4i @gmlewis