Skip to main content

Updates the package release​

Updates the package release

Path Parameters
    workspace stringrequired

    Workspace to use

    name stringrequired

    The name of the package release you wish or update

Query Parameters
    dryRun string

    Set to 'All' to perform a server-side dry run of updating this resource

    force string

    Set to 'true' to override read-only (has no effect unless used by Wayfinder admin)

    owner string

    Use an explicit owner for this resource - this must match the owner used on create, if set

    apply string

    Use server-side apply for this update instead of overwriting the whole object

Request Body required

The specification for the package release you are updating

    apiVersion string
    kind string
    metadata

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
    • clusterName string
    creationTimestamp string
    deletionGracePeriodSeconds int64
    deletionTimestamp string
    finalizers string[]
    generateName string
    generation int64
    labels object

    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 services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
    • managedFields undefined[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

    apiVersion string
    fieldsType string
    fieldsV1 string
    manager string
    operation string
    subresource string
    time string
    name string
    namespace string
    ownerReferences undefined[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    apiVersion stringrequired
    blockOwnerDeletion boolean
    controller boolean
    kind stringrequired
    name stringrequired
    uid stringrequired
    resourceVersion string
    selfLink string
    uid string
    spec

    PackageReleaseSpec defines the the desired status for an helm package

    clusterRef required

    ClusterRef provides reference to the cluster this release is associated and intended to be installed on

    group stringrequired
    kind stringrequired
    name stringrequired
    namespace stringrequired
    version stringrequired
    globalRef string
    package required

    Package contains all the package details which has been copied over from the package definition - this creates a local copy of the package as is used to reconcile the release

    dependencies string[]
    installNamespace stringrequired
    name stringrequired
    releaseName string
    selectors required

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions undefined[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    key stringrequired
    operator stringrequired
    values string[]
    matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
    • skipTests boolean
    source required
    git
    gitPullSecrets

    SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

    name string
    namespace string
    url string
    helm
    name string
    url string
    version string
    summary stringrequired
    userValues undefined[]
    description string
    name string
    value string
    values string
    valuesFrom undefined[]
    cloudAccessConfig
    key stringrequired
    path stringrequired
    specPath boolean
    valuePrefix string
    valueSuffix string
    cluster
    key stringrequired
    path stringrequired
    specPath boolean
    valuePrefix string
    valueSuffix string
    domain
    asArray boolean
    key stringrequired
    limit int64
    matchLabels

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions undefined[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    key stringrequired
    operator stringrequired
    values string[]
    matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
    • optional boolean
    path stringrequired
    specPath boolean
    valuePrefix string
    valueSuffix string
    resource
    group stringrequired
    key stringrequired
    kind stringrequired
    name stringrequired
    namespace stringrequired
    path stringrequired
    specPath boolean
    valuePrefix string
    valueSuffix string
    version stringrequired
    secret

    SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

    key stringrequired
    name string
    namespace string
    path stringrequired
    specPath boolean
    valuePrefix string
    valueSuffix string
    version stringrequired
    workloadIdentity
    cloudResourceName string
    clusterServiceAccount

    ClusterServiceAccount represents the identity inside the cluster that will use the workload identity

    name stringrequired
    namespace stringrequired
    identityOnly boolean
    providerDetails
    aws
    customIAMPolicy object
    helmServiceAccountAnnotationsPaths string[]
    iamPolicies string[]
    azure
    helmPodLabelsPaths string[]
    helmPodSelector string
    gcp
    helmServiceAccountAnnotationsPaths string[]
    role stringrequired
    roleParameters object
  • property name* string
    • packageRef string
    revision stringrequired
    status

    PackageReleaseStatus defines the observed state of the package

    appliedValues string
    cloudResourcesCreated boolean
    conditions undefined[]
    detail string
    lastTransitionTime stringrequired
    message string
    name stringrequired
    negativePolarity boolean
    observedGeneration int64
    reason stringrequired
    status stringrequired
    type stringrequired
    detail string
    lastReconcile
    generation int64required
    time stringrequired
    lastSuccess
    generation int64required
    time stringrequired
    message string
    obsoleteResources undefined[]
    kind stringrequired
    name stringrequired
    status stringrequired
    wayfinderVersion string

Responses​

Contains the package release definition

Schema
    apiVersion string
    kind string
    metadata

    ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

    annotations object

    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

  • property name* string
    • clusterName string
    creationTimestamp string
    deletionGracePeriodSeconds int64
    deletionTimestamp string
    finalizers string[]
    generateName string
    generation int64
    labels object

    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 services. More info: http://kubernetes.io/docs/user-guide/labels

  • property name* string
    • managedFields undefined[]

    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

    apiVersion string
    fieldsType string
    fieldsV1 string
    manager string
    operation string
    subresource string
    time string
    name string
    namespace string
    ownerReferences undefined[]

    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

    apiVersion string
    blockOwnerDeletion boolean
    controller boolean
    kind string
    name string
    uid string
    resourceVersion string
    selfLink string
    uid string
    spec

    PackageReleaseSpec defines the the desired status for an helm package

    clusterRef

    ClusterRef provides reference to the cluster this release is associated and intended to be installed on

    group string
    kind string
    name string
    namespace string
    version string
    globalRef string
    package

    Package contains all the package details which has been copied over from the package definition - this creates a local copy of the package as is used to reconcile the release

    dependencies string[]
    installNamespace string
    name string
    releaseName string
    selectors

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions undefined[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    key string
    operator string
    values string[]
    matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
    • skipTests boolean
    source
    git
    gitPullSecrets

    SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

    name string
    namespace string
    url string
    helm
    name string
    url string
    version string
    summary string
    userValues undefined[]
    description string
    name string
    value string
    values string
    valuesFrom undefined[]
    cloudAccessConfig
    key string
    path string
    specPath boolean
    valuePrefix string
    valueSuffix string
    cluster
    key string
    path string
    specPath boolean
    valuePrefix string
    valueSuffix string
    domain
    asArray boolean
    key string
    limit int64
    matchLabels

    A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

    matchExpressions undefined[]

    matchExpressions is a list of label selector requirements. The requirements are ANDed.

    key string
    operator string
    values string[]
    matchLabels object

    matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

  • property name* string
    • optional boolean
    path string
    specPath boolean
    valuePrefix string
    valueSuffix string
    resource
    group string
    key string
    kind string
    name string
    namespace string
    path string
    specPath boolean
    valuePrefix string
    valueSuffix string
    version string
    secret

    SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

    key string
    name string
    namespace string
    path string
    specPath boolean
    valuePrefix string
    valueSuffix string
    version string
    workloadIdentity
    cloudResourceName string
    clusterServiceAccount

    ClusterServiceAccount represents the identity inside the cluster that will use the workload identity

    name string
    namespace string
    identityOnly boolean
    providerDetails
    aws
    customIAMPolicy object
    helmServiceAccountAnnotationsPaths string[]
    iamPolicies string[]
    azure
    helmPodLabelsPaths string[]
    helmPodSelector string
    gcp
    helmServiceAccountAnnotationsPaths string[]
    role string
    roleParameters object
  • property name* string
    • packageRef string
    revision string
    status

    PackageReleaseStatus defines the observed state of the package

    appliedValues string
    cloudResourcesCreated boolean
    conditions undefined[]
    detail string
    lastTransitionTime string
    message string
    name string
    negativePolarity boolean
    observedGeneration int64
    reason string
    status string
    type string
    detail string
    lastReconcile
    generation int64
    time string
    lastSuccess
    generation int64
    time string
    message string
    obsoleteResources undefined[]
    kind string
    name string
    status string
    wayfinderVersion string
Loading...
Last updated on 28 Dec 2023