.TH "GCLOUD_BUILDS_CONNECTIONS_CREATE_GITHUB\-ENTERPRISE" 1



.SH "NAME"
.HP
gcloud builds connections create github\-enterprise \- create a Cloud Build Connection of type GitHub Enterprise



.SH "SYNOPSIS"
.HP
\f5gcloud builds connections create github\-enterprise\fR (\fICONNECTION\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) \fB\-\-host\-uri\fR=\fIHOST_URI\fR [\fB\-\-async\fR] [\fB\-\-app\-id\fR=\fIAPP_ID\fR\ \fB\-\-app\-slug\fR=\fIAPP_SLUG\fR\ \fB\-\-private\-key\-secret\-version\fR=\fIPRIVATE_KEY_SECRET_VERSION\fR\ \fB\-\-webhook\-secret\-secret\-version\fR=\fIWEBHOOK_SECRET_SECRET_VERSION\fR\ :\ \fB\-\-app\-installation\-id\fR=\fIAPP_INSTALLATION_ID\fR] [\fB\-\-service\-directory\-service\fR=\fISERVICE_DIRECTORY_SERVICE\fR\ :\ \fB\-\-ssl\-ca\-file\fR=\fISSL_CA_FILE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Create a Cloud Build Connection of type GitHub Enterprise.

Connections for GitHub Enterprise can be created either by following an
intallation process (that requires manual steps in a web browser) or by
providing all the properties of an already\-installed application as arguments
to this command.

If the GitHub Enterprise server can only be accessed within a VPC, a Service
Directory service resource can be provided for connecting to it.



.SH "EXAMPLES"

To create a connection by following the installation process, provide only the
connection name and the host URI. If the server can only be accessed within a
VPC, provide also the Service Directory service resource:

.RS 2m
$ gcloud builds connections create github\-enterprise my\-ghe\-conn \e
    \-\-project=myproj \-\-region=us\-central1 \e
    \-\-host\-uri=https://my.ghe\-server.net \e
    \-\-service\-directory\-service=projects/myproj/namespaces/x/\e
services/mysds
.RE

The command will print a URL to be opened in a web browser in order create and
install a GitHub App in that server. After following the URL, you can get the
connection's installation state with The \f5\fIdescribe\fR\fR command:

.RS 2m
$ gcloud alpha builds connections describe my\-ghe\-conn \e
    \-\-region=us\-central1
.RE

If the connection's installation state is not COMPLETE yet, it will provide a
link to continue the installation process. Once the connection is in
installation state COMPLETE, repositories can be added to it (see
\f5\fIgcloud\fR\fR alpha builds repositories create).

\-\-

To create a complete connection (e.g. based on an existing installation),
provide all the parameters:

.RS 2m
$ gcloud builds connections create github\-enterprise my\-ghe\-conn \e
    \-\-project=myproj \-\-region=us\-central1 \-\-app\-id=111 \e
    \-\-app\-slug=gcb\-app \e
    \-\-service\-directory\-service=projects/myproj/namespaces/x/\e
services/mysds \e
    \-\-private\-key\-secret\-version=projects/myproj/secrets/pk/\e
versions/1 \e
    \-\-webhook\-secret\-secret\-version=projects/myproj/secrets/\e
whsecret/versions/1 \-\-app\-slug=myapp \-\-app\-installation\-id=1234
.RE

Above command creates the connection in installation state COMPLETE, ready for
adding repositories.



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Connection resource \- Connection to create. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes are not
given arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5connection\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fICONNECTION\fR

ID of the connection or fully qualified identifier for the connection.

To set the \f5connection\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5connection\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The Google Cloud region.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5connection\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5builds/region\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-host\-uri\fR=\fIHOST_URI\fR

URI of the GitHub Enterprise server.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m

Group of arguments for the GitHub App properties.


.RS 2m
.TP 2m
\fB\-\-app\-id\fR=\fIAPP_ID\fR

App ID of the GitHub App in the GitHub Enterprise server.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-app\-slug\fR=\fIAPP_SLUG\fR

App slug (url\-friendly name) of the GitHub App. When seeing the configuration
page of the App (e.g. in https://my\-ghe\-server.net/settings/apps/my\-app), the
app\-slug is the last component of the URL path ("my\-app" in that example).

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-private\-key\-secret\-version\fR=\fIPRIVATE_KEY_SECRET_VERSION\fR

Secret containing the private key of the GitHub App.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-webhook\-secret\-secret\-version\fR=\fIWEBHOOK_SECRET_SECRET_VERSION\fR

Secret containing the webhook secret string for validating webhook events
generated by the GitHub App.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-app\-installation\-id\fR=\fIAPP_INSTALLATION_ID\fR

Installation ID of the Cloud Build GitHub App.

.RE
.sp
.TP 2m

Group of arguments for configuring access through Service Directory.


.RS 2m
.TP 2m
\fB\-\-service\-directory\-service\fR=\fISERVICE_DIRECTORY_SERVICE\fR

Service Directory service resource to use for accessing the GitHub Enterprise
Server. Necessary only if the server has no public access from the internet.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-ssl\-ca\-file\fR=\fISSL_CA_FILE\fR

File containing the SSL_CA to be used.


.RE
.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBcloudbuild/v2\fR API. The full documentation for this
API can be found at: https://cloud.google.com/cloud\-build/docs/



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha builds connections create github\-enterprise
.RE

.RS 2m
$ gcloud beta builds connections create github\-enterprise
.RE