Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.73 KB

github-app.md

File metadata and controls

53 lines (36 loc) · 1.73 KB

GitHub OAuth App setup

Register the OAuth application on GitHub

Register an OAuth application on GitHub for the Pipeline API and CI/CD workflow.

Fill in Authorization callback URL. This field has to be updated once the Control Plane is up and running using the IP address or the DNS name:

  • For local usage:

    http://localhost:9090/auth/github/callback

  • For on-cloud usage:

    http://{control_plane_public_ip}/auth/github/callback

Take note of the Client ID and Client Secret as these will be required for launching the Pipeline Control Plane.

Acquiring the access token

For accessing the Pipeline one has to be authenticated via GitHub. For programmatic API access an access token has to be generated.

Tokens can be generated only with a browser (for now), to do that please use the following URL:

  • For local usage:

    http://localhost:9090/auth/github/login

  • For on-cloud usage:

    http://{control_plane_public_ip}/auth/github/login

Please authenticate yourself with GitHub. If everything is done correctly you will be redirected. The browser already contains the generated token. It can be retrieved by issuing the following:

  • For local usage:

    http://localhost:9090/api/v1/token

  • For on-cloud usage:

    http://{control_plane_public_ip}/pipeline/api/v1/token