GVC (Global Virtual Cloud)

This section outlines the key attributes of the gvc's API object. This object can be utilized through the API, CLI and the console's apply functionality.

id string

name string

Max Length: 64

kind string

version integer

description string

Max Length: 250

tags object

created string

Format: date-time

lastModified string

Format: date-time

links array of objects - See Below

alias string

spec object - See Below

rel string

href string

spec

staticPlacement object - See Below

pullSecretLinks array of strings

domain string

tracing object - See Below

sidecar object - See Schema

env array of objects - See Below

These environment variables will be available to any workload in the GVC. Note: a workload must opt-in to receive these variables.

loadBalancer object - See Below

staticPlacement

locationLinks array of strings

locationQuery object - See Below

locationQuery

kind string

context object

spec object - See Below

spec

match string

Default: all

Possible enum values:

  • all

  • any

  • none

terms array of objects - See Below

terms

op string

Default: =

Possible enum values:

  • =

  • >

  • >=

  • <

  • <=

  • !=

  • ~

  • exists

  • !exists

property string

rel string

tag string

value string

Format: date-time

tracing

sampling number

lightstep object - See Below

customTags object

provider object - See Below

lightstep

endpoint string

credentials string

provider

otel object - See Below

lightstep object - See Below

otel

endpoint string

env

These environment variables will be available to any workload in the GVC. Note: a workload must opt-in to receive these variables.

name string

Max Length: 120

value string

Max Length: 4096

loadBalancer

dedicated boolean

Creates a dedicated load balancer in each location and enables additional Domain features: custom ports, protocols and wildcard hostnames. Charges apply for each location.

trustedProxies integer

Controls the address used for request logging and for setting the X-Envoy-External-Address header. If set to 1, then the last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If set to 2, then the second to last address in an existing X-Forwarded-For header will be used in place of the source client IP address. If the XFF header does not have at least two addresses or does not exist then the source client IP address will be used instead.

Copyright © 2024 Control Plane Corporation. All rights reserved. Revision fe68539f
Contents