What Operators do

• Operator manage and configure instance with UI
• Operator builds automation with API
• Operator does fire fighting with ssh + bash script

What can the purpose of an API/CLI

• Part of the UI architecture and support a robust UI solution
• Help operators build an reliable and efficient automation

What is needed for UI support

• see feature parity https://docs.google.com/spreadsheets/d/1TtKi6EbIHnuQXnz2NhJTD4GdE8G70udTiy0054qvIq0/edit?gid=0#gid=0
• see issues created: https://github.com/github/ghes/issues/8626

What is needed for automation:

From Tim:

• see https://docs.google.com/document/d/1WKHYk6yZZrLO6_xaHcRAGBgReNwJfbBaN2ENHqtc_0o/edit?tab=t.0

support feed backs:https://github.slack.com/archives/C0171GMTK1A/p1744185205744479

• https://github.zendesk.com/agent/tickets/3081773 : Trenchant: an API endpoint to administer certificates
• https://github.zendesk.com/agent/tickets/3057620 : a full example of automated instance creation
• https://github.zendesk.com/agent/tickets/2837202 : ssl file uploading

customer feedbacks:

• Ability to schedule automated support-bundle submission

• Would like to be able to monitor the upgrade progress via command line

• Allow creation of first admin user via API(s) or CLI

API feedback : https://github.com/orgs/github/projects/12068/views/1

GHES - Add ability to set/reset management console password via the API

Would like a REST API endpoint which provides the same functionality as ghe-ssl-certificate-setup

Request for API endpoint to get elasticsearch indexing status on GHES ### customer's ansible playbooks

what do customers automate:

query: org:githubcustomers path:/**/*.yml "hosts:" "tasks:"

• ha-fail-over: Santander , JPMC, tesla

• setup cache replica: tesla, synamedia

• support-bundle-cron-job: Spotofy, synamedia

• setup-backup: synamedia,

interesting automation users:

• apple: https://github.com/githubcustomers/Apple-ACI/tree/main/code/hubot/ansible

• synamedia: https://github.com/githubcustomers/Synamedia/tree/master/automation/iac/ansible/playbooks

• bosch : https://github.com/githubcustomers/Bosch/tree/main/scripts/ansible/ansible

• lyft (powershell): https://github.com/githubcustomers/Lyft/tree/main/scripts/GHAdmin

customers that likely used API for automation:

3.14 ha:

• Saab(3.14 ha) Inc /v1/replication/status: 581

3.15 ha

• Gap Inc /v1/maintenance: 21

• College of Engineering Georgia Tech /v1/maintenance: 16

• Twilio /v1/maintenance: 19

• General Assembly /v1/maintenance: 13

• AIG /v1/maintenance: 11

• Starbucks Coffee Company /v1/maintenance: 12

• Centers for Medicare u0026 Medicaid Services /v1/maintenance: 8

3.15 standalone

• Appgate /v1/maintenance: 29
• George Labs GmbH /v1/maintenance: 29
• Extreme Networks /v1/maintenance: 24

road blocks to a self-contained API

• a native way to store and edit github conf files

• a paved road for long running operations

• some errors:

500 found in file:  <_io.TextIOWrapper name='/home/esbtools/163446/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to GET : /v1/config/settings
500 found in file: <_io.TextIOWrapper name='/home/esbtools/163131/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to GET : /v1/maintenance
500 found in file: <_io.TextIOWrapper name='/home/esbtools/164052/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to GET : /v1/maintenance
400 found in file: <_io.TextIOWrapper name='/home/esbtools/163210/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to POST : /v1/topologyconfig/verify
400 found in file: <_io.TextIOWrapper name='/home/esbtools/163496/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to POST : /v1/topologyconfig/verify
400 found in file: <_io.TextIOWrapper name='/home/esbtools/163581/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to POST : /v1/topologyconfig/verify
400 found in file: <_io.TextIOWrapper name='/home/esbtools/163581/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to POST : /v1/topologyconfig
500 found in file: <_io.TextIOWrapper name='/home/esbtools/163976/system-logs/systemd/ghes-manage-gateway.log' mode='r' encoding='UTF-8'>, on call to POST : /v1/topologyconfig

Not related:

Display monitoring graphs in same timezone as user

Log Forward Replication Status