Service
Service acts as a top-level container that manages a set of Routes and Configurations which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership. Service acts only as an orchestrator of the underlying Routes and Configurations (much as a kubernetes Deployment orchestrates ReplicaSets).
The Service’s controller will track the statuses of its owned Configuration and Route, reflecting their statuses and conditions as its own.
See also: https://github.com/knative/serving/blob/master/docs/spec/overview.md#service
To get more information about Service, see:
- API documentation
- How-to Guides
Create a Service Resource
new Service(name: string, args: ServiceArgs, opts?: CustomResourceOptions);def Service(resource_name, opts=None, autogenerate_revision_name=None, location=None, metadata=None, name=None, project=None, template=None, traffics=None, __props__=None);func NewService(ctx *Context, name string, args ServiceArgs, opts ...ResourceOption) (*Service, error)public Service(string name, ServiceArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
Service Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Service resource accepts the following input properties:
- Location string
The location of the cloud run instance. eg us-central1
- Autogenerate
Revision boolName If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- Metadata
Service
Metadata Args Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- Name string
Name of the environment variable.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Template
Service
Template Args template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- Traffics
List<Service
Traffic Args> Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
- Location string
The location of the cloud run instance. eg us-central1
- Autogenerate
Revision boolName If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- Metadata
Service
Metadata Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- Name string
Name of the environment variable.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Template
Service
Template template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- Traffics
[]Service
Traffic Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
- location string
The location of the cloud run instance. eg us-central1
- autogenerate
Revision booleanName If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- metadata
Service
Metadata Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- name string
Name of the environment variable.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- template
Service
Template template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- traffics
Service
Traffic[] Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
- location str
The location of the cloud run instance. eg us-central1
- autogenerate_
revision_ boolname If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- metadata
Dict[Service
Metadata] Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- name str
Name of the environment variable.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- template
Dict[Service
Template] template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- traffics
List[Service
Traffic] Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the Service resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Service
Status The current status of the Service.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Service
Status The current status of the Service.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Service
Status The current status of the Service.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Dict[Service
Status] The current status of the Service.
Look up an Existing Service Resource
Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServiceState, opts?: CustomResourceOptions): Servicestatic get(resource_name, id, opts=None, autogenerate_revision_name=None, location=None, metadata=None, name=None, project=None, status=None, template=None, traffics=None, __props__=None);func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Autogenerate
Revision boolName If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- Location string
The location of the cloud run instance. eg us-central1
- Metadata
Service
Metadata Args Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- Name string
Name of the environment variable.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Status
Service
Status Args The current status of the Service.
- Template
Service
Template Args template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- Traffics
List<Service
Traffic Args> Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
- Autogenerate
Revision boolName If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- Location string
The location of the cloud run instance. eg us-central1
- Metadata
Service
Metadata Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- Name string
Name of the environment variable.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Status
Service
Status The current status of the Service.
- Template
Service
Template template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- Traffics
[]Service
Traffic Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
- autogenerate
Revision booleanName If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- location string
The location of the cloud run instance. eg us-central1
- metadata
Service
Metadata Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- name string
Name of the environment variable.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- status
Service
Status The current status of the Service.
- template
Service
Template template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- traffics
Service
Traffic[] Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
- autogenerate_
revision_ boolname If set to
true, the revision name (template.metadata.name) will be omitted and autogenerated by Cloud Run. This cannot be set totruewhiletemplate.metadata.nameis also set. (For legacy support, iftemplate.metadata.nameis unset in state while this field is set to false, the revision name will still autogenerate.)- location str
The location of the cloud run instance. eg us-central1
- metadata
Dict[Service
Metadata] Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- name str
Name of the environment variable.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- status
Dict[Service
Status] The current status of the Service.
- template
Dict[Service
Template] template holds the latest specification for the Revision to be stamped out. The template references the container image, and may also include labels and annotations that should be attached to the Revision. To correlate a Revision, and/or to force a Revision to be created when the spec doesn’t otherwise change, a nonce label may be provided in the template metadata. For more details, see: https://github.com/knative/serving/blob/master/docs/client-conventions.md#associate-modifications-with-revisions Cloud Run does not currently support referencing a build that is responsible for materializing the container image from source. Structure is documented below.
- traffics
List[Service
Traffic] Traffic specifies how to distribute traffic over a collection of Knative Revisions and Configurations Structure is documented below.
Supporting Types
ServiceMetadata
- Annotations Dictionary<string, string>
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- Generation int
- A sequence number representing a specific generation of the desired state.
- Labels Dictionary<string, string>
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- Namespace string
In Cloud Run the namespace must be equal to either the project ID or project number.
- Resource
Version string - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- Self
Link string - SelfLink is a URL representing this object.
- Uid string
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- Annotations map[string]string
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- Generation int
- A sequence number representing a specific generation of the desired state.
- Labels map[string]string
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- Namespace string
In Cloud Run the namespace must be equal to either the project ID or project number.
- Resource
Version string - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- Self
Link string - SelfLink is a URL representing this object.
- Uid string
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- annotations {[key: string]: string}
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- generation number
- A sequence number representing a specific generation of the desired state.
- labels {[key: string]: string}
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- namespace string
In Cloud Run the namespace must be equal to either the project ID or project number.
- resource
Version string - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- self
Link string - SelfLink is a URL representing this object.
- uid string
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- annotations Dict[str, str]
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- generation float
- A sequence number representing a specific generation of the desired state.
- labels Dict[str, str]
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- namespace str
In Cloud Run the namespace must be equal to either the project ID or project number.
- resource
Version str - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- self_
link str - SelfLink is a URL representing this object.
- uid str
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
ServiceStatus
See the output API doc for this type.
See the output API doc for this type.
See the output API doc for this type.
ServiceStatusCondition
See the output API doc for this type.
See the output API doc for this type.
See the output API doc for this type.
ServiceTemplate
- Metadata
Service
Template Metadata Args Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- Spec
Service
Template Spec Args RevisionSpec holds the desired state of the Revision (from the client). Structure is documented below.
- Metadata
Service
Template Metadata Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- Spec
Service
Template Spec RevisionSpec holds the desired state of the Revision (from the client). Structure is documented below.
- metadata
Service
Template Metadata Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- spec
Service
Template Spec RevisionSpec holds the desired state of the Revision (from the client). Structure is documented below.
- metadata
Dict[Service
Template Metadata] Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.
- spec
Dict[Service
Template Spec] RevisionSpec holds the desired state of the Revision (from the client). Structure is documented below.
ServiceTemplateMetadata
- Annotations Dictionary<string, string>
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- Generation int
- A sequence number representing a specific generation of the desired state.
- Labels Dictionary<string, string>
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- Name string
Name of the environment variable.
- Namespace string
In Cloud Run the namespace must be equal to either the project ID or project number.
- Resource
Version string - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- Self
Link string - SelfLink is a URL representing this object.
- Uid string
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- Annotations map[string]string
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- Generation int
- A sequence number representing a specific generation of the desired state.
- Labels map[string]string
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- Name string
Name of the environment variable.
- Namespace string
In Cloud Run the namespace must be equal to either the project ID or project number.
- Resource
Version string - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- Self
Link string - SelfLink is a URL representing this object.
- Uid string
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- annotations {[key: string]: string}
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- generation number
- A sequence number representing a specific generation of the desired state.
- labels {[key: string]: string}
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- name string
Name of the environment variable.
- namespace string
In Cloud Run the namespace must be equal to either the project ID or project number.
- resource
Version string - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- self
Link string - SelfLink is a URL representing this object.
- uid string
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
- annotations Dict[str, str]
Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations
- generation float
- A sequence number representing a specific generation of the desired state.
- labels Dict[str, str]
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels
- name str
Name of the environment variable.
- namespace str
In Cloud Run the namespace must be equal to either the project ID or project number.
- resource
Version str - An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
- self_
link str - SelfLink is a URL representing this object.
- uid str
- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
ServiceTemplateSpec
- Container
Concurrency int ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Values are: -
0thread-safe, the system should manage the max concurrency. This is the default value. -1not-thread-safe. Single concurrency -2-Nthread-safe, max concurrency of N- Containers
List<Service
Template Spec Container Args> Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md Structure is documented below.
- Service
Account stringName Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project’s default service account.
- Serving
State string - ServingState holds a value describing the state the resources are in for this Revision. It is expected that the system will manipulate this based on routability and load.
- Timeout
Seconds int TimeoutSeconds holds the max duration the instance is allowed for responding to a request.
- Container
Concurrency int ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Values are: -
0thread-safe, the system should manage the max concurrency. This is the default value. -1not-thread-safe. Single concurrency -2-Nthread-safe, max concurrency of N- Containers
[]Service
Template Spec Container Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md Structure is documented below.
- Service
Account stringName Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project’s default service account.
- Serving
State string - ServingState holds a value describing the state the resources are in for this Revision. It is expected that the system will manipulate this based on routability and load.
- Timeout
Seconds int TimeoutSeconds holds the max duration the instance is allowed for responding to a request.
- container
Concurrency number ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Values are: -
0thread-safe, the system should manage the max concurrency. This is the default value. -1not-thread-safe. Single concurrency -2-Nthread-safe, max concurrency of N- containers
Service
Template Spec Container[] Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md Structure is documented below.
- service
Account stringName Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project’s default service account.
- serving
State string - ServingState holds a value describing the state the resources are in for this Revision. It is expected that the system will manipulate this based on routability and load.
- timeout
Seconds number TimeoutSeconds holds the max duration the instance is allowed for responding to a request.
- container
Concurrency float ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Values are: -
0thread-safe, the system should manage the max concurrency. This is the default value. -1not-thread-safe. Single concurrency -2-Nthread-safe, max concurrency of N- containers
List[Service
Template Spec Container] Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md Structure is documented below.
- service_
account_ strname Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project’s default service account.
- serving
State str - ServingState holds a value describing the state the resources are in for this Revision. It is expected that the system will manipulate this based on routability and load.
- timeout
Seconds float TimeoutSeconds holds the max duration the instance is allowed for responding to a request.
ServiceTemplateSpecContainer
- Image string
Docker image name. This is most often a reference to a container located in the container registry, such as gcr.io/cloudrun/hello More info: https://kubernetes.io/docs/concepts/containers/images
- Args List<string>
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Commands List<string>
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Env
Froms List<ServiceTemplate Spec Container Env From Args> - (Optional, Deprecated) List of sources to populate environment variables in the container. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Structure is documented below.
- Envs
List<Service
Template Spec Container Env Args> List of environment variables to set in the container. Structure is documented below.
- Resources
Service
Template Spec Container Resources Args Compute Resources required by this container. Used to set values such as max memory More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below.
- Working
Dir string - (Optional, Deprecated) Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image.
- Image string
Docker image name. This is most often a reference to a container located in the container registry, such as gcr.io/cloudrun/hello More info: https://kubernetes.io/docs/concepts/containers/images
- Args []string
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Commands []string
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- Env
Froms []ServiceTemplate Spec Container Env From - (Optional, Deprecated) List of sources to populate environment variables in the container. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Structure is documented below.
- Envs
[]Service
Template Spec Container Env List of environment variables to set in the container. Structure is documented below.
- Resources
Service
Template Spec Container Resources Compute Resources required by this container. Used to set values such as max memory More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below.
- Working
Dir string - (Optional, Deprecated) Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image.
- image string
Docker image name. This is most often a reference to a container located in the container registry, such as gcr.io/cloudrun/hello More info: https://kubernetes.io/docs/concepts/containers/images
- args string[]
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- commands string[]
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- env
Froms ServiceTemplate Spec Container Env From[] - (Optional, Deprecated) List of sources to populate environment variables in the container. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Structure is documented below.
- envs
Service
Template Spec Container Env[] List of environment variables to set in the container. Structure is documented below.
- resources
Service
Template Spec Container Resources Compute Resources required by this container. Used to set values such as max memory More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below.
- working
Dir string - (Optional, Deprecated) Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image.
- image str
Docker image name. This is most often a reference to a container located in the container registry, such as gcr.io/cloudrun/hello More info: https://kubernetes.io/docs/concepts/containers/images
- args List[str]
Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- commands List[str]
Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
- env
Froms List[ServiceTemplate Spec Container Env From] - (Optional, Deprecated) List of sources to populate environment variables in the container. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Structure is documented below.
- envs
List[Service
Template Spec Container Env] List of environment variables to set in the container. Structure is documented below.
- resources
Dict[Service
Template Spec Container Resources] Compute Resources required by this container. Used to set values such as max memory More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below.
- working
Dir str - (Optional, Deprecated) Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image.
ServiceTemplateSpecContainerEnv
- Name string
Name of the environment variable.
- Value string
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.
- Name string
Name of the environment variable.
- Value string
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.
- name string
Name of the environment variable.
- value string
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.
- name str
Name of the environment variable.
- value str
Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.
ServiceTemplateSpecContainerEnvFrom
- Config
Map ServiceRef Template Spec Container Env From Config Map Ref Args The ConfigMap to select from. Structure is documented below.
- Prefix string
An optional identifier to prepend to each key in the ConfigMap.
- Secret
Ref ServiceTemplate Spec Container Env From Secret Ref Args The Secret to select from. Structure is documented below.
- Config
Map ServiceRef Template Spec Container Env From Config Map Ref The ConfigMap to select from. Structure is documented below.
- Prefix string
An optional identifier to prepend to each key in the ConfigMap.
- Secret
Ref ServiceTemplate Spec Container Env From Secret Ref The Secret to select from. Structure is documented below.
- config
Map ServiceRef Template Spec Container Env From Config Map Ref The ConfigMap to select from. Structure is documented below.
- prefix string
An optional identifier to prepend to each key in the ConfigMap.
- secret
Ref ServiceTemplate Spec Container Env From Secret Ref The Secret to select from. Structure is documented below.
- config
Map Dict[ServiceRef Template Spec Container Env From Config Map Ref] The ConfigMap to select from. Structure is documented below.
- prefix str
An optional identifier to prepend to each key in the ConfigMap.
- secret
Ref Dict[ServiceTemplate Spec Container Env From Secret Ref] The Secret to select from. Structure is documented below.
ServiceTemplateSpecContainerEnvFromConfigMapRef
- Local
Object ServiceReference Template Spec Container Env From Config Map Ref Local Object Reference Args The Secret to select from. Structure is documented below.
- Optional bool
Specify whether the Secret must be defined
- Local
Object ServiceReference Template Spec Container Env From Config Map Ref Local Object Reference The Secret to select from. Structure is documented below.
- Optional bool
Specify whether the Secret must be defined
- local
Object ServiceReference Template Spec Container Env From Config Map Ref Local Object Reference The Secret to select from. Structure is documented below.
- optional boolean
Specify whether the Secret must be defined
- local
Object Dict[ServiceReference Template Spec Container Env From Config Map Ref Local Object Reference] The Secret to select from. Structure is documented below.
- optional bool
Specify whether the Secret must be defined
ServiceTemplateSpecContainerEnvFromConfigMapRefLocalObjectReference
ServiceTemplateSpecContainerEnvFromSecretRef
- Local
Object ServiceReference Template Spec Container Env From Secret Ref Local Object Reference Args The Secret to select from. Structure is documented below.
- Optional bool
Specify whether the Secret must be defined
- Local
Object ServiceReference Template Spec Container Env From Secret Ref Local Object Reference The Secret to select from. Structure is documented below.
- Optional bool
Specify whether the Secret must be defined
- local
Object ServiceReference Template Spec Container Env From Secret Ref Local Object Reference The Secret to select from. Structure is documented below.
- optional boolean
Specify whether the Secret must be defined
- local
Object Dict[ServiceReference Template Spec Container Env From Secret Ref Local Object Reference] The Secret to select from. Structure is documented below.
- optional bool
Specify whether the Secret must be defined
ServiceTemplateSpecContainerEnvFromSecretRefLocalObjectReference
ServiceTemplateSpecContainerResources
- Limits Dictionary<string, string>
Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- Requests Dictionary<string, string>
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- Limits map[string]string
Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- Requests map[string]string
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- limits {[key: string]: string}
Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- requests {[key: string]: string}
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- limits Dict[str, str]
Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
- requests Dict[str, str]
Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go
ServiceTraffic
- Percent int
Percent specifies percent of the traffic to this Revision or Configuration.
- Latest
Revision bool LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty.
- Revision
Name string RevisionName of a specific revision to which to send this portion of traffic.
- Percent int
Percent specifies percent of the traffic to this Revision or Configuration.
- Latest
Revision bool LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty.
- Revision
Name string RevisionName of a specific revision to which to send this portion of traffic.
- percent number
Percent specifies percent of the traffic to this Revision or Configuration.
- latest
Revision boolean LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty.
- revision
Name string RevisionName of a specific revision to which to send this portion of traffic.
- percent float
Percent specifies percent of the traffic to this Revision or Configuration.
- latest
Revision bool LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty.
- revision
Name str RevisionName of a specific revision to which to send this portion of traffic.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.