1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 23:08:48 +00:00
gcloud-help/gcloud/edge-cloud/container/vpn-connections/create

130 lines
4.8 KiB
Text
Raw Normal View History

2022-04-06 08:36:53 +00:00
NAME
gcloud edge-cloud container vpn-connections create - create a VPN
connection between an Edge Container cluster and a VPC network
SYNOPSIS
2023-04-12 10:43:12 +00:00
gcloud edge-cloud container vpn-connections create VPN_CONNECTION
--cluster=CLUSTER --vpc-network=VPC_NETWORK [--async]
[--high-availability] [--labels=[KEY=VALUE,...]] [--location=LOCATION]
[--nat-gateway-ip=NAT_GATEWAY_IP] [--vpc-project=VPC_PROJECT]
[GCLOUD_WIDE_FLAG ...]
2022-04-06 08:36:53 +00:00
DESCRIPTION
Creates a new VPN connection.
EXAMPLES
To create a connection called 'my-vpn-connection' between the VPC network
'my-vpc' and the Edge Container cluster 'my-cluster' which is at region
us-central1, run:
$ gcloud edge-cloud container vpn-connections create \
my-vpn-connection --location=us-central1 \
--vpc-network='my-vpc' --cluster='my-cluster'
Here VPC network and cluster should be under the same project.
POSITIONAL ARGUMENTS
2023-04-12 10:43:12 +00:00
Vpn connection resource - VPN connection to create. This represents a
Cloud resource. (NOTE) Some attributes are not given arguments in this
2023-05-04 10:43:54 +00:00
group but can be set in other ways.
To set the project attribute:
2022-04-06 08:36:53 +00:00
◆ provide the argument vpn_connection on the command line with a fully
specified name;
◆ set the property core/project;
2023-05-04 10:43:54 +00:00
◆ provide the argument --project on the command line.
To set the location attribute:
2023-04-12 10:43:12 +00:00
◆ provide the argument vpn_connection on the command line with a fully
specified name;
◆ provide the argument --location on the command line;
◆ set the property edge_container/location.
2022-04-06 08:36:53 +00:00
This must be specified.
VPN_CONNECTION
ID of the vpn connection or fully qualified identifier for the vpn
2023-05-04 10:43:54 +00:00
connection.
To set the vpn_connection attribute:
2022-04-06 08:36:53 +00:00
▸ provide the argument vpn_connection on the command line.
2023-04-12 10:43:12 +00:00
REQUIRED FLAGS
Cluster resource - The name of the cluster to be connected under current
project. This represents a Cloud resource. (NOTE) Some attributes are not
2023-05-04 10:43:54 +00:00
given arguments in this group but can be set in other ways.
To set the project attribute:
2023-04-12 10:43:12 +00:00
◆ provide the argument --cluster on the command line with a fully
specified name;
◆ set the property core/project;
2023-05-04 10:43:54 +00:00
◆ provide the argument --project on the command line.
To set the location attribute:
2023-04-12 10:43:12 +00:00
◆ provide the argument --cluster on the command line with a fully
specified name;
◆ provide the argument --location on the command line;
◆ set the property edge_container/location.
2022-04-06 08:36:53 +00:00
2023-04-12 10:43:12 +00:00
This must be specified.
2022-04-06 08:36:53 +00:00
2023-04-12 10:43:12 +00:00
--cluster=CLUSTER
2023-05-04 10:43:54 +00:00
ID of the cluster or fully qualified identifier for the cluster.
To set the cluster attribute:
2023-04-12 10:43:12 +00:00
▸ provide the argument --cluster on the command line.
2022-04-06 08:36:53 +00:00
--vpc-network=VPC_NETWORK
2022-09-08 09:21:50 +00:00
The name of the VPC network to be connected. By default it is assumed
to be under the same project as cluster. If this VPC network is under a
2023-01-25 10:09:52 +00:00
different project, vpc-project is required.
2022-04-06 08:36:53 +00:00
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--high-availability
Enables high availability on cluster side. This creates an additional
VPN endpoint in cluster. Multiple Nodes/NodePools are required to
enable this feature.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers. Values must
contain only hyphens (-), underscores (_), lowercase characters, and
numbers.
2023-04-12 10:43:12 +00:00
--location=LOCATION
For resources [vpn connection, cluster], provides fallback value for
resource location attribute. When the resource's full URI path is not
provided, location will fallback to this flag value.
2022-04-06 08:36:53 +00:00
--nat-gateway-ip=NAT_GATEWAY_IP
2022-09-08 09:21:50 +00:00
The NAT gateway IP for the gateway floating IPs. Required if cluster
sits behind NAT.
2022-04-06 08:36:53 +00:00
2023-02-08 10:13:59 +00:00
--vpc-project=VPC_PROJECT
The project of the VPC network. Required if the project of VPC network
differs from the project of the cluster.
2022-04-06 08:36:53 +00:00
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 $ gcloud help for details.
API REFERENCE
This command uses the edgecontainer/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/edge-cloud
NOTES
This variant is also available:
$ gcloud alpha edge-cloud container vpn-connections create