Created
January 15, 2021 01:12
-
-
Save epk/1d1ab2ae3b7abc1f67585ff74e522541 to your computer and use it in GitHub Desktop.
backend-config-schema.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| apiVersion: apiextensions.k8s.io/v1 | |
| kind: CustomResourceDefinition | |
| metadata: | |
| creationTimestamp: "2021-01-07T15:25:19Z" | |
| generation: 1 | |
| name: backendconfigs.cloud.google.com | |
| resourceVersion: "993" | |
| selfLink: /apis/apiextensions.k8s.io/v1/customresourcedefinitions/backendconfigs.cloud.google.com | |
| uid: 04022ede-4398-4ca9-9c23-c5f5e659c819 | |
| spec: | |
| conversion: | |
| strategy: None | |
| group: cloud.google.com | |
| names: | |
| kind: BackendConfig | |
| listKind: BackendConfigList | |
| plural: backendconfigs | |
| shortNames: | |
| - bc | |
| singular: backendconfig | |
| scope: Namespaced | |
| versions: | |
| - name: v1 | |
| schema: | |
| openAPIV3Schema: | |
| properties: | |
| apiVersion: | |
| description: 'APIVersion defines the versioned schema of this representation | |
| of an object. Servers should convert recognized schemas to the latest | |
| internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' | |
| type: string | |
| kind: | |
| description: 'Kind is a string value representing the REST resource this | |
| object represents. Servers may infer this from the endpoint the client | |
| submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' | |
| type: string | |
| metadata: | |
| type: object | |
| spec: | |
| description: BackendConfigSpec is the spec for a BackendConfig resource | |
| properties: | |
| cdn: | |
| description: CDNConfig contains configuration for CDN-enabled backends. | |
| properties: | |
| cachePolicy: | |
| description: CacheKeyPolicy contains configuration for how requests | |
| to a CDN-enabled backend are cached. | |
| properties: | |
| includeHost: | |
| description: If true, requests to different hosts will be | |
| cached separately. | |
| type: boolean | |
| includeProtocol: | |
| description: If true, http and https requests will be cached | |
| separately. | |
| type: boolean | |
| includeQueryString: | |
| description: If true, query string parameters are included | |
| in the cache key according to QueryStringBlacklist and QueryStringWhitelist. | |
| If neither is set, the entire query string is included and | |
| if false the entire query string is excluded. | |
| type: boolean | |
| queryStringBlacklist: | |
| description: Names of query strint parameters to exclude from | |
| cache keys. All other parameters are included. Either specify | |
| QueryStringBlacklist or QueryStringWhitelist, but not both. | |
| items: | |
| type: string | |
| type: array | |
| queryStringWhitelist: | |
| description: Names of query string parameters to include in | |
| cache keys. All other parameters are excluded. Either specify | |
| QueryStringBlacklist or QueryStringWhitelist, but not both. | |
| items: | |
| type: string | |
| type: array | |
| type: object | |
| enabled: | |
| type: boolean | |
| required: | |
| - enabled | |
| type: object | |
| connectionDraining: | |
| description: ConnectionDrainingConfig contains configuration for connection | |
| draining. For now the draining timeout. May manage more settings | |
| in the future. | |
| properties: | |
| drainingTimeoutSec: | |
| description: Draining timeout in seconds. | |
| format: int64 | |
| type: integer | |
| type: object | |
| customRequestHeaders: | |
| description: CustomRequestHeadersConfig contains configuration for | |
| custom request headers | |
| properties: | |
| headers: | |
| items: | |
| type: string | |
| type: array | |
| type: object | |
| healthCheck: | |
| description: HealthCheckConfig contains configuration for the health | |
| check. | |
| properties: | |
| checkIntervalSec: | |
| description: CheckIntervalSec is a health check parameter. See | |
| https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| healthyThreshold: | |
| description: HealthyThreshold is a health check parameter. See | |
| https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| port: | |
| description: Port is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| If Port is used, the controller updates portSpecification as | |
| well | |
| format: int64 | |
| type: integer | |
| requestPath: | |
| description: RequestPath is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| type: string | |
| timeoutSec: | |
| description: TimeoutSec is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| type: | |
| description: Type is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| type: string | |
| unhealthyThreshold: | |
| description: UnhealthyThreshold is a health check parameter. See | |
| https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| type: object | |
| iap: | |
| description: IAPConfig contains configuration for IAP-enabled backends. | |
| properties: | |
| enabled: | |
| type: boolean | |
| oauthclientCredentials: | |
| description: OAuthClientCredentials contains credentials for a | |
| single IAP-enabled backend. | |
| properties: | |
| clientID: | |
| description: Direct reference to OAuth client id. | |
| type: string | |
| clientSecret: | |
| description: Direct reference to OAuth client secret. | |
| type: string | |
| secretName: | |
| description: The name of a k8s secret which stores the OAuth | |
| client id & secret. | |
| type: string | |
| required: | |
| - secretName | |
| type: object | |
| required: | |
| - enabled | |
| - oauthclientCredentials | |
| type: object | |
| logging: | |
| description: LogConfig contains configuration for logging. | |
| properties: | |
| enable: | |
| description: This field denotes whether to enable logging for | |
| the load balancer traffic served by this backend service. | |
| type: boolean | |
| sampleRate: | |
| description: This field can only be specified if logging is enabled | |
| for this backend service. The value of the field must be in | |
| [0, 1]. This configures the sampling rate of requests to the | |
| load balancer where 1.0 means all logged requests are reported | |
| and 0.0 means no logged requests are reported. The default value | |
| is 1.0. | |
| format: double | |
| type: number | |
| type: object | |
| securityPolicy: | |
| description: SecurityPolicyConfig contains configuration for CloudArmor-enabled | |
| backends. | |
| properties: | |
| name: | |
| description: Name of the security policy that should be associated. | |
| type: string | |
| required: | |
| - name | |
| type: object | |
| sessionAffinity: | |
| description: SessionAffinityConfig contains configuration for stickyness | |
| parameters. | |
| properties: | |
| affinityCookieTtlSec: | |
| format: int64 | |
| type: integer | |
| affinityType: | |
| type: string | |
| type: object | |
| timeoutSec: | |
| format: int64 | |
| type: integer | |
| type: object | |
| status: | |
| type: object | |
| type: object | |
| served: true | |
| storage: true | |
| - name: v1beta1 | |
| schema: | |
| openAPIV3Schema: | |
| properties: | |
| apiVersion: | |
| description: 'APIVersion defines the versioned schema of this representation | |
| of an object. Servers should convert recognized schemas to the latest | |
| internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' | |
| type: string | |
| kind: | |
| description: 'Kind is a string value representing the REST resource this | |
| object represents. Servers may infer this from the endpoint the client | |
| submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' | |
| type: string | |
| metadata: | |
| type: object | |
| spec: | |
| description: BackendConfigSpec is the spec for a BackendConfig resource | |
| properties: | |
| cdn: | |
| description: CDNConfig contains configuration for CDN-enabled backends. | |
| properties: | |
| cachePolicy: | |
| description: CacheKeyPolicy contains configuration for how requests | |
| to a CDN-enabled backend are cached. | |
| properties: | |
| includeHost: | |
| description: If true, requests to different hosts will be | |
| cached separately. | |
| type: boolean | |
| includeProtocol: | |
| description: If true, http and https requests will be cached | |
| separately. | |
| type: boolean | |
| includeQueryString: | |
| description: If true, query string parameters are included | |
| in the cache key according to QueryStringBlacklist and QueryStringWhitelist. | |
| If neither is set, the entire query string is included and | |
| if false the entire query string is excluded. | |
| type: boolean | |
| queryStringBlacklist: | |
| description: Names of query strint parameters to exclude from | |
| cache keys. All other parameters are included. Either specify | |
| QueryStringBlacklist or QueryStringWhitelist, but not both. | |
| items: | |
| type: string | |
| type: array | |
| queryStringWhitelist: | |
| description: Names of query string parameters to include in | |
| cache keys. All other parameters are excluded. Either specify | |
| QueryStringBlacklist or QueryStringWhitelist, but not both. | |
| items: | |
| type: string | |
| type: array | |
| type: object | |
| enabled: | |
| type: boolean | |
| required: | |
| - enabled | |
| type: object | |
| connectionDraining: | |
| description: ConnectionDrainingConfig contains configuration for connection | |
| draining. For now the draining timeout. May manage more settings | |
| in the future. | |
| properties: | |
| drainingTimeoutSec: | |
| description: Draining timeout in seconds. | |
| format: int64 | |
| type: integer | |
| type: object | |
| customRequestHeaders: | |
| description: CustomRequestHeadersConfig contains configuration for | |
| custom request headers | |
| properties: | |
| headers: | |
| items: | |
| type: string | |
| type: array | |
| type: object | |
| healthCheck: | |
| description: HealthCheckConfig contains configuration for the health | |
| check. | |
| properties: | |
| checkIntervalSec: | |
| description: CheckIntervalSec is a health check parameter. See | |
| https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| healthyThreshold: | |
| description: HealthyThreshold is a health check parameter. See | |
| https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| port: | |
| description: Port is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| If Port is used, the controller updates portSpecification as | |
| well | |
| format: int64 | |
| type: integer | |
| requestPath: | |
| description: RequestPath is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| type: string | |
| timeoutSec: | |
| description: TimeoutSec is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| type: | |
| description: Type is a health check parameter. See https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| type: string | |
| unhealthyThreshold: | |
| description: UnhealthyThreshold is a health check parameter. See | |
| https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks. | |
| format: int64 | |
| type: integer | |
| type: object | |
| iap: | |
| description: IAPConfig contains configuration for IAP-enabled backends. | |
| properties: | |
| enabled: | |
| type: boolean | |
| oauthclientCredentials: | |
| description: OAuthClientCredentials contains credentials for a | |
| single IAP-enabled backend. | |
| properties: | |
| clientID: | |
| description: Direct reference to OAuth client id. | |
| type: string | |
| clientSecret: | |
| description: Direct reference to OAuth client secret. | |
| type: string | |
| secretName: | |
| description: The name of a k8s secret which stores the OAuth | |
| client id & secret. | |
| type: string | |
| required: | |
| - secretName | |
| type: object | |
| required: | |
| - enabled | |
| - oauthclientCredentials | |
| type: object | |
| logging: | |
| description: LogConfig contains configuration for logging. | |
| properties: | |
| enable: | |
| description: This field denotes whether to enable logging for | |
| the load balancer traffic served by this backend service. | |
| type: boolean | |
| sampleRate: | |
| description: This field can only be specified if logging is enabled | |
| for this backend service. The value of the field must be in | |
| [0, 1]. This configures the sampling rate of requests to the | |
| load balancer where 1.0 means all logged requests are reported | |
| and 0.0 means no logged requests are reported. The default value | |
| is 1.0. | |
| format: double | |
| type: number | |
| type: object | |
| securityPolicy: | |
| description: SecurityPolicyConfig contains configuration for CloudArmor-enabled | |
| backends. | |
| properties: | |
| name: | |
| description: Name of the security policy that should be associated. | |
| type: string | |
| required: | |
| - name | |
| type: object | |
| sessionAffinity: | |
| description: SessionAffinityConfig contains configuration for stickyness | |
| parameters. | |
| properties: | |
| affinityCookieTtlSec: | |
| format: int64 | |
| type: integer | |
| affinityType: | |
| type: string | |
| type: object | |
| timeoutSec: | |
| format: int64 | |
| type: integer | |
| type: object | |
| status: | |
| type: object | |
| type: object | |
| served: true | |
| storage: false | |
| status: | |
| acceptedNames: | |
| kind: BackendConfig | |
| listKind: BackendConfigList | |
| plural: backendconfigs | |
| shortNames: | |
| - bc | |
| singular: backendconfig | |
| conditions: | |
| - lastTransitionTime: "2021-01-07T15:25:19Z" | |
| message: no conflicts found | |
| reason: NoConflicts | |
| status: "True" | |
| type: NamesAccepted | |
| - lastTransitionTime: "2021-01-07T15:25:19Z" | |
| message: the initial names have been accepted | |
| reason: InitialNamesAccepted | |
| status: "True" | |
| type: Established | |
| storedVersions: | |
| - v1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment