KRM API marketplace.global.gdc.goog/v1

marketplace.global.gdc.goog/v1

Contains API Schema definitions for the Marketplace API group.

CatalogOwner

CatalogOwner represents Catalog Owner Information including the Catalog Admin Account and the Catalog Owning Team.

Appears in: - ServiceCatalogSpec

Field Description
admin string Catalog Admin Account.
team string Catalog Owning Team.

IconType

Underlying type: string IconType represents the type of icon asset.

Appears in: - ServiceDescriptionSpec

NameSelector

Provides a list of Project Name for Service Catalog Binding to match with.

Appears in: - ServiceCatalogBindingSelector

Field Description
matchNames string array

ServiceCatalog

Represents a single group of Marketplace services.

Appears in: - ServiceCatalogList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalog
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceCatalogSpec
status ServiceCatalogStatus

ServiceCatalogBinding

Represents a ServiceCatalog to Project mapping relations.

Appears in: - ServiceCatalogBindingList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalogBinding
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceCatalogBindingSpec
status ServiceCatalogBindingStatus

ServiceCatalogBindingList

Represents a collection of ServiceCatalogBinding custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalogBindingList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceCatalogBinding array

ServiceCatalogBindingReplica

Represents a ServiceCatalog to Project mapping relations.

Appears in: - ServiceCatalogBindingReplicaList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalogBindingReplica
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceCatalogBindingSpec
status ServiceCatalogBindingReplicaStatus

ServiceCatalogBindingReplicaList

Represents a collection of ServiceCatalogBindingReplica custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalogBindingReplicaList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceCatalogBindingReplica array

ServiceCatalogBindingSelector

Provides a set of rules to match Projects. Must choose exactly 0 or 1 of the selectors. 0 selector matches all Projects.

Appears in: - ServiceCatalogBindingSpec

Field Description
nameSelector NameSelector NameSelector is used to specify the list of names of Projects.
labelSelector LabelSelector LabelSelector is used to specify the list of label and values of Projects.

ServiceCatalogBindingSpec

Provides the specification, or desired state, of a ServiceCatalogBinding resource.

Appears in: - ServiceCatalogBinding - ServiceCatalogBindingReplica

Field Description
serviceCatalogRef NamespacedName ServiceCatalogRef represents the ServiceCatalog in this ServiceCatalogBinding.
selector ServiceCatalogBindingSelector Selector is used to specify a set of rules to match Projects.

ServiceCatalogBindingStatus

Provides the overall status of a global service catalog binding.

Appears in: - ServiceCatalogBinding

Field Description
conditions Condition array The observations of the overall state of the resource. Known condition types: Ready.
rollout RolloutStatus The current strategy used to roll out the resource to each zone.
zones ServiceCatalogBindingZoneStatus array The list of zone statuses where the resource is rolled out to.

ServiceCatalogBindingZoneStatus

Provides the status of a Service Catalog rolling out to a particular zone.

Appears in: - ServiceCatalogBindingStatus

Field Description
name string The name of the zone where the replica this status represents is in.
rolloutStatus ZoneRolloutStatus The status of rolling out the replica to the zone.
replicaStatus ServiceCatalogBindingReplicaStatus The reconciliation status of the replica collected from the zone. Any condition within the field that has an .observedGeneration less than .rolloutStatus.replicaGeneration is out of date.

ServiceCatalogList

Represents a collection of ServiceCatalog custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalogList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceCatalog array

ServiceCatalogReplica

Represents a single group of Marketplace services.

Appears in: - ServiceCatalogReplicaList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalogReplica
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceCatalogSpec
status ServiceCatalogReplicaStatus

ServiceCatalogReplicaList

Represents a collection of ServiceCatalogReplica custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceCatalogReplicaList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceCatalogReplica array

ServiceCatalogSpec

ServiceCatalogSpec defines catalog owner information and a list of accessible Service Descriptions.

Appears in: - ServiceCatalog - ServiceCatalogReplica

Field Description
displayName string Display name for this ServiceCatalog.
owner CatalogOwner Catalog Owner Information.
serviceDescriptionRef NamespacedName array List of Service Descriptions Included in the ServiceCatalog.

ServiceCatalogStatus

Provides the overall status of a global service catalog.

Appears in: - ServiceCatalog

Field Description
conditions Condition array The observations of the overall state of the resource. Known condition types: Ready.
rollout RolloutStatus The current strategy used to roll out the resource to each zone.
zones ServiceCatalogZoneStatus array The list of zone statuses where the resource is rolled out to.

ServiceCatalogZoneStatus

Provides the status of a Service Catalog rolling out to a particular zone.

Appears in: - ServiceCatalogStatus

Field Description
name string The name of the zone where the replica this status represents is in.
rolloutStatus ZoneRolloutStatus The status of rolling out the replica to the zone.
replicaStatus ServiceCatalogReplicaStatus The reconciliation status of the replica collected from the zone. Any condition within the field that has an .observedGeneration less than .rolloutStatus.replicaGeneration is out of date.

ServiceDescription

ServiceDescription represents a description of a Marketplace service.

Appears in: - ServiceDescriptionList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceDescription
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceDescriptionSpec
status ServiceDescriptionStatus

ServiceDescriptionDetails

ServiceDescriptionDetails defines the fields available for a given section.

Appears in: - ServiceDescriptionSpec

Field Description
details string Description details HTML-formatted section.
url string Description URL, if available.

ServiceDescriptionList

Represents a collection of ServiceDescription custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceDescriptionList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceDescription array

ServiceDescriptionReplica

Represents a description of a Marketplace service.

Appears in: - ServiceDescriptionReplicaList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceDescriptionReplica
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceDescriptionSpec
status ServiceDescriptionReplicaStatus

ServiceDescriptionReplicaList

Represents a collection of ServiceDescriptionReplica custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceDescriptionReplicaList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceDescriptionReplica array

ServiceDescriptionSpec

ServiceDescriptionSpec defines a service description of a Marketplace service.

Appears in: - ServiceDescription - ServiceDescriptionReplica

Field Description
serviceName string Selector value corresponding to "marketplace.gdc.goog/service-name" label.
displayName string Display name for this service.
vendor string Vendor for this service.
description string Short description for this service.
serviceType string Type of this service for Overview page.
iconType IconType Type of icon asset.
iconSource string Source data for the icon asset, e.g. base64-encoded image.
overview string Service overview HTML-formatted section.
pricing ServiceDescriptionDetails Service pricing HTML-formatted section.
support string Service support HTML-formatted section.
terms ServiceDescriptionDetails Service terms HTML-formatted section.
contactInfo string Service contact info HTML-formatted section.
documentation ServiceDescriptionDetails Service documentation details.
categories string array Additional details for "Categories".

ServiceDescriptionStatus

Provides the overall status of a global service description.

Appears in: - ServiceDescription

Field Description
conditions Condition array The observations of the overall state of the resource. Known condition types: Ready.
rollout RolloutStatus The current strategy used to roll out the resource to each zone.
zones ServiceDescriptionZoneStatus array The list of zone statuses where the resource is rolled out to.

ServiceDescriptionZoneStatus

Provides the status of a Service Description rolling out to a particular zone.

Appears in: - ServiceDescriptionStatus

Field Description
name string The name of the zone where the replica this status represents is in.
rolloutStatus ZoneRolloutStatus The status of rolling out the replica to the zone.
replicaStatus ServiceDescriptionReplicaStatus The reconciliation status of the replica collected from the zone. Any condition within the field that has an .observedGeneration less than .rolloutStatus.replicaGeneration is out of date.

ServiceVersion

Represents a single version of a Marketplace service.

Appears in: - ServiceVersionList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceVersion
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceVersionSpec
status ServiceVersionStatus

ServiceVersionList

Represents a collection of ServiceVersion custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceVersionList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceVersion array

ServiceVersionReplica

Represents a single version of a Marketplace service.

Appears in: - ServiceVersionReplicaList

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceVersionReplica
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec ServiceVersionSpec
status ServiceVersionReplicaStatus

ServiceVersionReplicaList

Represents a collection of ServiceVersionReplica custom resources.

Field Description
apiVersion string marketplace.global.gdc.goog/v1
kind string ServiceVersionReplicaList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items ServiceVersionReplica array

ServiceVersionSpec

Defines an available version of a Marketplace service.

Appears in: - ServiceVersion - ServiceVersionReplica

Field Description
version string The version of this service.
harborProject string The name of the project where service Helm is stored.
entrypoint string The name of the Helm chart whose lifecycle will be managed.
defaultConfiguration string The default configuration of the Helm chart values.

ServiceVersionStatus

Provides the overall status of a global service version.

Appears in: - ServiceVersion

Field Description
conditions Condition array The observations of the overall state of the resource. Known condition types: Ready.
rollout RolloutStatus The current strategy used to roll out the resource to each zone.
zones ServiceVersionZoneStatus array The list of zone statuses where the resource is rolled out to.

ServiceVersionZoneStatus

Provides the status of a Service Version rolling out to a particular zone.

Appears in: - ServiceVersionStatus

Field Description
name string The name of the zone where the replica this status represents is in.
rolloutStatus ZoneRolloutStatus The status of rolling out the replica to the zone.
replicaStatus ServiceVersionReplicaStatus The reconciliation status of the replica collected from the zone. Any condition within the field that has an .observedGeneration less than .rolloutStatus.replicaGeneration is out of date.