SCM

This component is responsible for integrating with a source control management (SCM) system based off the configuration provided.

The SCM system is used by Vela for both authentication and authorization of interactions performed within the application.

Configuration

The following options are used to configure the component:

Name	Description	Required	Default	Environment Variables
scm.addr	fully qualified url for the SCM	true	https://github.com	SCM_ADDR`VELA_SCM_ADDR`
scm.client	client ID from the generated OAuth application on the SCM	true	N/A	SCM_CLIENT`VELA_SCM_CLIENT`
scm.context	message to set in commit status on the SCM	true	continuous-integration/vela	SCM_CONTEXT`VELA_SCM_CONTEXT`
scm.driver	type of client to control and operate SCM	true	github	SCM_DRIVER`VELA_SCM_DRIVER`
scm.scopes	permission scopes to apply for the OAuth credentials on the SCM	true	[ repo, repo:status, user:email, read:user, read:org ]	SCM_SCOPES`VELA_SCM_SCOPES`
scm.secret	client secret from the generated OAuth application on the SCM	true	N/A	SCM_SECRET`VELA_SCM_SECRET`
scm.webhook.addr	url for webhooks on the SCM to send requests to	false	the address of the Vela server ($VELA_ADDR)	SCM_WEBHOOK_ADDR`VELA_SCM_WEBHOOK_ADDR`

note

For more information on these configuration options, please see the server reference.

Drivers

The following drivers are available to configure the component:

Name	Description	Documentation
github	uses a GitHub or GitHug Enterprise Server for the SCM	https://github.com/about/

GitHub

From the GitHub official website:

GitHub is where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

The below configuration displays an example of creating a GitHub OAuth application:

warning

The Homepage URL should match the VELA_ADDR environment variable provided to the server for clusters without a UI.

Otherwise, the Homepage URL should match the VELA_WEBUI_ADDR environment variable provided to the server.

The Authorization callback URL should contain the VELA_ADDR environment variable with a /authenticate suffix.

GitHub Enterprise Server

From the GitHub Enterprise official website:

GitHub Enterprise Server is your organization's private copy of GitHub contained within a virtual appliance, hosted on premises or in the cloud, that you configure and control.

The below configuration displays an example of creating a GitHub Enterprise Server OAuth application:

warning

The Homepage URL should match the VELA_ADDR environment variable provided to the server for clusters without a UI.

Otherwise, the Homepage URL should match the VELA_WEBUI_ADDR environment variable provided to the server.

The Authorization callback URL should contain the VELA_ADDR environment variable with a /authenticate suffix.