Returns a specific package release
GET/resources/package.appvia.io/v2beta2/workspaces/:workspace/packagereleases/:name
Returns a specific package release
Request
Path Parameters
Workspace to use
The name of the package release you wish to retrieve
Responses
- 200
- 401
- 403
- 404
- 500
Contains the package release definition
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
Array [
]
]
Array [
]
Array [
]
Array [
]
Array [
]
- An IAM role is created and associated with a specific Kubernetes service account
- no inline or attached policies are managed (post creation of the IAM role)
- It is a "user" responsibility to attach policies to the IAM role In Azure:
- The user defined managed identity is created
- No role definitions or role assignments are created
- It is a "user" responsibility to create relevant role assignments
- roleDefinitionName: Reader scope: /subscriptions/{{ .CloudAccessConfig.Azure.Subscription }}/resourceGroups/{{ .Cluster.Azure.ResourceGroup }}
- role: roles/dns.admin scopeType: DNS scopeID: {{ .ZoneID }}
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
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
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
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
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 defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
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.
API version of the referent.
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
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. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
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
package
required
PackageSpec defines a helm package
Dependencies provides a list of dependent services which have to deployed before this package can be installed
Description provides short description as to use of the package
helm
Helm is a helm chart
ChartName is the name of the chart to install
ChartVersion is the version of the chart to install
HelmTimeout is the duration to wait for helm install/upgrade operations to complete. If unspecified, the default timeout in Flux will be used.
ReleaseName is the name of the release in the cluster
RepositoryRef is a reference to a Repository resource to use for the chart repo. If provided, the referenced Repository resource must reference the same URL as the RepositoryURL field.
RepositoryURL is the url to the helm repository where the chart lives. If repositoryRef provided, this must point to the same URL as the referenced Repository.
SkipTests will skip execution of any 'helm test' tests defined on the package.
Values is a collection of values to injected into the chart when rendering the package into the clusters Deprecated: Values is deprecated and will be removed in a future release - please use ValuesTemplate
valuesFrom
undefined[]
ValuesFrom is a optional collection of resources which are injected Deprecated: ValuesFrom is deprecated and will be removed in a future release - please use ValuesTemplate into the helm values before render
cloudAccessConfig
cluster
domain
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 is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
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.
resource
secret
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
name is unique within a namespace to reference a secret resource.
namespace defines the space within which the secret name must be unique.
valuesFromSecret
undefined[]
ValuesFromSecret is an optional collections of values to take from a secret
SecretRef is the reference to the platform secret
ValuesTemplate is a template containing the values to use
InstallNamespace is the location to install the package
manifests
undefined[]
Manifests defines kubernetes resources that should be deployed. Manifests will be deployed in the order specified.
Name is an optional name for this manifest. This name is used only for your reference and has no meaning to Wayfinder.
Template is a template of the resource
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 is the label key that the selector applies to.
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
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.
userValues
undefined[]
UserValues is a collection of user values that are exposed by this package
Description is an explanation of value's significance/usage
Name is the name of the value field
Value is a representation of the value
Version identifies the version of this overall package. It must be incremented to produce new publishable/consumable versions of the package definition.
Most fields are immutable without incrementing this version.
Must be a valid semver in the format X.Y.Z without a 'v' prefix. An optional -suffix can be provided; note in semver that 1.0.0 is after 1.0.0-1.
workloadIdentity
WorkloadIdentity is an optional request to create a workload identity
BuiltInRoleName must be the name of a valid workload identity role known to Wayfinder
CloudResourceName specifies the name of the workload identity in the cloudaccount Can be left blank so that the name is derived from the cluster name + resource name
IdentityOnly will create an identity associated with a cluster with no specific permissions Must specify Role=None if this is true. In AWS:
providerDetails
ProviderDetails provides additional fields which can be used for cloud-provider specific data, such as a GCP billing account ID.
aws
AWS holds parameters specific to AWS workload identity
CustomIAMPolicy defines an additional dedicated IAM policy to create and bind to this workload identity.
helmServiceAccountAnnotationsPaths defines paths to the service account annotations parameter within the helm chart. AWS ManagedIdentity works based on ServiceAccounts annotations.
IAMPolicies defines a list of (additional) IAM policies to bind to the workload identity role It is assumed that these will exist in the target AWS account for the cluster, therefore use either built-in AWS-managed policies or make sure that your process for managing policies in your accounts will always ensure these policies exist in any account this package may be deployed into. For AWS-managed policies, specify the full ARN (e.g. arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess) For self-managed policies, specify the ARN without an account ID (e.g. arn:aws:iam:::policy/myorg-policy-s3-write)
azure
Azure holds parameters specific to Azure workload identity
ClientIDPaths defines paths to additional places in the values to set the client ID
HelmPodLabelsPath defines paths to the podLabels parameter within the helm chart. Azure ManagedIdentity works based on Pod labels.
HelmServiceAccountAnnotationsPaths defines paths to the service account annotations parameter within the helm chart.
gcp
GCP holds parameters specific to GCP workload identity
HelmServiceAccountAnnotationsPaths defines paths to the service account annotations parameter within the helm chart. GCP ManagedIdentity works based on ServiceAccounts annotations.
role
Role allows the permissions of a workload identity to be specified
aws
AWS holds parameters specific to an AWS workload identity IRSA role
CustomIAMPolicyTemplate is a YAML (or json) template to produce a custom IAM policy to bind to the workload identity role. The template must compile to a valid AWS policy document. E.g.: Version: "2012-10-17" Statement: Effect: Allow Action: s3:ListBucket Resource: arn:aws:s3:::example_bucket
IAMPolicyARNs defines a list of IAM policies to bind to the workload identity role These must exist in the target AWS account. E.g. arn:aws:iam::aws:policy/aws-service-role/AccessAnalyzerServiceRolePolicy arn:aws:iam::aws:policy/acme-org-policy-s3-write
azure
Azure holds parameters specific to an Azure workload identity
RoleAssignmentsTemplate is a template to produce a custom role assignment to bind to the workload identity role. The template must compile to our Azure role assignment structure. See (v2beta2.AzureWorkloadIdentityRoleAssignment). E.g.:
gcp
GCP holds parameters specific to GCP workload identity
IAMRoleBindingsTemplate is a YAML template to produce a GCP policy to bind to the workload identity. The template must compile to an array of our GCP role policy bindings See (v2beta2.GCPWorkloadIdentityPolicyBinding). E.g.:
roleParameters
object
RoleParameters are any parameters required for the specified role
ServiceAccountName is the name of the service account in the installNamespace which will use this identity in the target cluster.
PackageRef is the name of the package that this release is from
Revision is revision of the package in which is associated to the release
status
PackageReleaseStatus defines the observed state of the package
AppliedIdentityAccess is the rendered workload identity access for this package release
AppliedManifests is the rendered set of manifests for this package release
AppliedValues is the rendered set of values for this package release (excluding any values derived from secrets)
conditions
undefined[]
failedEvents
undefined[]
FailedEvents is a list of events from the namespace where the release is installed Only warnings and errors are included Only populated if the release has failed
Message is the message of the event
regarding
required
Regarding is the reference to the object the event is about
Kind is the kind of the object
Name is the name of the object
Namespace is the namespace of the object
invalidManifestTemplates
undefined[]
InvalidManifestTemplates are the rendered result of the manifest template(s) This allows troubleshooting of invalid rendered kubernetes manifests Is NOT populated if all the manifest templates are valid (as this data is in the AppliedManifests field)
Error is the error message from the invalid manifest (rendering or yaml parsing error)
Index is the index of the manifest template this result is for
InvalidManifest is the invalid manifest
Name is the name of the manifest template this result is for if present
InvalidValuesTemplateResult is the rendered result of the package release values template This allows troubleshooting of invalid rendered values Is NOT populated if the values template is valid (as this data is in the AppliedValues field)
InvalidWorkloadIdentityTemplate is the rendered result of the workload identity role template This allows troubleshooting of invalid rendered workload identity role Is NOT populated if the workload identity role template is valid (as this data is in the AppliedIdentityAccess field)
lastReconcile
lastSuccess
obsoleteResources
undefined[]
ownedResources
cloudResources
undefined[]
wayfinderResources
undefined[]
pendingSince
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": {},
"creationTimestamp": "string",
"deletionGracePeriodSeconds": 0,
"deletionTimestamp": "string",
"finalizers": [
"string"
],
"generateName": "string",
"generation": 0,
"labels": {},
"managedFields": [
{
"apiVersion": "string",
"fieldsType": "string",
"fieldsV1": "string",
"manager": "string",
"operation": "string",
"subresource": "string",
"time": "string"
}
],
"name": "string",
"namespace": "string",
"ownerReferences": [
{
"apiVersion": "string",
"blockOwnerDeletion": true,
"controller": true,
"kind": "string",
"name": "string",
"uid": "string"
}
],
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"clusterRef": {
"group": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"version": "string"
},
"package": {
"dependencies": [
"string"
],
"description": "string",
"helm": {
"chartName": "string",
"chartVersion": "string",
"helmTimeout": "string",
"releaseName": "string",
"repositoryRef": "string",
"repositoryURL": "string",
"skipTests": true,
"values": "string",
"valuesFrom": [
{
"cloudAccessConfig": {
"apiVersion": "string",
"key": "string",
"path": "string",
"specPath": true,
"valuePrefix": "string",
"valueSuffix": "string"
},
"cluster": {
"key": "string",
"path": "string",
"specPath": true,
"valuePrefix": "string",
"valueSuffix": "string"
},
"domain": {
"asArray": true,
"key": "string",
"limit": 0,
"matchLabels": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"optional": true,
"path": "string",
"specPath": true,
"valuePrefix": "string",
"valueSuffix": "string"
},
"resource": {
"group": "string",
"key": "string",
"kind": "string",
"name": "string",
"namespace": "string",
"path": "string",
"specPath": true,
"valuePrefix": "string",
"valueSuffix": "string",
"version": "string"
},
"secret": {
"key": "string",
"name": "string",
"namespace": "string",
"path": "string",
"specPath": true,
"valuePrefix": "string",
"valueSuffix": "string"
}
}
],
"valuesFromSecret": [
{
"key": "string",
"path": "string",
"secretRef": "string",
"specPath": true,
"valuePrefix": "string",
"valueSuffix": "string"
}
],
"valuesTemplate": "string"
},
"installNamespace": "string",
"manifests": [
{
"name": "string",
"template": "string"
}
],
"selectors": {
"matchExpressions": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"matchLabels": {}
},
"userValues": [
{
"description": "string",
"name": "string",
"value": "string"
}
],
"version": "string",
"workloadIdentity": {
"builtInRoleName": "string",
"cloudResourceName": "string",
"identityOnly": true,
"providerDetails": {
"aws": {
"customIAMPolicy": {},
"helmServiceAccountAnnotationsPaths": [
"string"
],
"iamPolicies": [
"string"
]
},
"azure": {
"clientIDPaths": [
"string"
],
"helmPodLabelsPaths": [
"string"
],
"helmPodSelector": "string",
"helmServiceAccountAnnotationsPaths": [
"string"
]
},
"gcp": {
"helmServiceAccountAnnotationsPaths": [
"string"
]
}
},
"role": {
"aws": {
"customIAMPolicyTemplate": "string",
"iamPolicyARNs": [
"string"
]
},
"azure": {
"roleAssignmentsTemplate": "string"
},
"gcp": {
"iamRoleBindingsTemplate": "string"
}
},
"roleParameters": {},
"serviceAccountName": "string"
}
},
"packageRef": "string",
"revision": "string"
},
"status": {
"appliedIdentityAccess": "string",
"appliedManifests": [
null
],
"appliedValues": "string",
"cloudResourcesCreated": true,
"conditions": [
{
"detail": "string",
"lastTransitionTime": "string",
"message": "string",
"name": "string",
"negativePolarity": true,
"observedGeneration": 0,
"reason": "string",
"status": "string",
"type": "string"
}
],
"detail": "string",
"failedEvents": [
{
"message": "string",
"regarding": {
"kind": "string",
"name": "string",
"namespace": "string"
}
}
],
"invalidManifestTemplates": [
{
"error": "string",
"index": 0,
"invalidManifest": "string",
"name": "string"
}
],
"invalidValuesTemplateResult": "string",
"invalidWorkloadIdentityTemplate": "string",
"lastReconcile": {
"generation": 0,
"time": "string"
},
"lastSuccess": {
"generation": 0,
"time": "string"
},
"message": "string",
"obsoleteResources": [
{
"kind": "string",
"name": "string"
}
],
"ownedResources": {
"cloudResources": [
{
"cloud": "string",
"id": "string",
"name": "string",
"type": "string"
}
],
"wayfinderResources": [
{
"kind": "string",
"name": "string",
"workspace": "string"
}
]
},
"pendingSince": {
"generation": 0,
"time": "string"
},
"status": "string",
"wayfinderVersion": "string"
}
}
If not authenticated
If authenticated but not authorized
the package release with the given name doesn't exist
A generic API error containing the cause of the error
- application/json
- Schema
- Example (from schema)
Schema
{
"code": 0,
"detail": "string",
"message": "string",
"uri": "string",
"verb": "string"
}