Skip to main content

Returns a specific app env

GET 

/resources/app.appvia.io/v2beta1/workspaces/:workspace/appenvs/:name

Returns a specific app env

Request

Path Parameters

    workspace stringrequired

    Workspace to use

    name stringrequired

    The name of the app env you wish to retrieve

Responses

Contains the app env definition

Schema

    apiVersion string

    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 string

    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

    property name* string
    creationTimestamp string

    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

    deletionGracePeriodSeconds int64

    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 string

    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

    finalizers string[]

    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 string

    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

    generation int64

    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

    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.

  • Array [

  • apiVersion string

    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 string

    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

    fieldsV1 string

    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

    manager string

    Manager is an identifier of the workflow managing these fields.

    operation string

    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 string

    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 string

    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 string

    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 string

    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.

  • Array [

  • apiVersion stringrequired

    API version of the referent.

    blockOwnerDeletion boolean

    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.

    controller boolean

    If true, this reference points to the managing controller.

    kind stringrequired

    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

    name stringrequired

    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

    uid stringrequired

    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

  • ]

  • resourceVersion 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. 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

    selfLink string

    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

    uid string

    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

    AppEnvSpec defines an environment for an application

    application stringrequired

    Application is the name of the application that this environment belongs to.

    cloud stringrequired

    Cloud defines which cloud provider this application is being developed for.

    cloudAccessConfigRef

    CloudAccessConfigRef is a reference to the cloud access configuration to use when building the cluster Deprecated: Only new AppEnvs with ClusterRef are now supported.

    name stringrequired
    workspace string

    clusterRef

    ClusterRef defines the cluster on which this application environment should be hosted. Either ClusterPlan or ClusterRef must be specified. If unspecified, the reference to the created cluster will be set by Wayfinder.

    group stringrequired
    kind stringrequired
    name stringrequired
    namespace stringrequired
    version stringrequired
    key string

    Key is a unique (within the appliction), short DNS-compatible name for this environment. If unspecified on creation a suitable value will be derived from the name. If specified, it will be validated for uniqueness on entry.

    name stringrequired

    Name is the unique (within the application) human-readable name for this environment.

    namespace stringrequired

    Namespace is the requested name for the environment's namespace on the specified cluster. If unpopulated, Wayfinder will auto-populate this with a sensible name on entry.

    order int32

    Order gives a numeric ordering of this environment, used to sort environments in a logical sequence. If two environments for an app have the same order, their display order is undefined and may change.

    plan string

    Plan is the name of the plan to use to build a new cluster for this environment. Deprecated: Use ClusterRef instead.

    region string

    Region is the cloud region. Deprecated: The region was only used for cluster provisioning, which is also deprecated.

    stage stringrequired

    Stage is the infrastructure stage to which this environment belongs

    vars

    undefined[]

    Vars is a set of variables specific to this app environment. These variables can be used in container component environment variables (see AppComponent spec.container.containers[].env) and cloud resource component input variables (see AppComponent spec.cloudResource.envVars)

  • Array [

  • name stringrequired

    Name is the name of this variable, used to reference it in app component definitions.

    value stringrequired

    Value is the value of the variable

  • ]

  • status

    AppEnvStatus defines the status of an application environment

    certIssuers string[]

    CertIssuers are the certificate issuers which can be used in this app env

    cloudResourcesCreated boolean

    conditions

    undefined[]

  • Array [

  • detail string
    lastTransitionTime stringrequired
    message string
    name stringrequired
    negativePolarity boolean
    observedGeneration int64
    reason stringrequired
    status stringrequired
    type stringrequired
  • ]

  • deployment

    Deployment shows the deployed status of the app to this environment. The deployment status will be updated approximately once per minute, to get up to date status, call the deploystatus subresource API of the appenv.

    components

    undefined[]

    Components describes the status of the deployed components

  • Array [

  • certReady boolean

    CertReady indicates if the HTTPS certificate is ready, if exposed and TLS is enabled.

    cloudResource

    CloudResource identifies the status of the cloud resource associated with this component, when the component type is CloudResource.

    moduleVersion string

    ModuleVersion identifies which Terraform version of the module was used to build this cloud resource.

    plan string

    Plan identifies the cloud resource plan used for this cloud resource

    ready boolean

    Ready indicates whether the cloud resource represented by this component is in sync with the definition last deployed - i.e. the actual cloud resource is present and correct.

    component stringrequired

    Component identifies which component this status is about.

    componentType stringrequired

    ComponentType defines what type of component this is.

    deployed boolean

    Deployed will be true if this component is deployed in this environment.

    endpoint string

    Endpoint identifies the DNS endpoint for this component, if exposed.

    exposed boolean

    Exposed will be true if this component is accessible outside the cluster, i.e. has an ingress.

    pods

    undefined[]

    Pods gives a detailed status for each pod for this component in the environment.

  • Array [

  • conditions

    undefined[]

  • Array [

  • lastProbeTime string

    Last time we probed the condition.

    lastTransitionTime string

    Last time the condition transitioned from one status to another.

    message string

    Human-readable message indicating details about last transition.

    reason string

    Unique, one-word, CamelCase reason for the condition's last transition.

    status stringrequired

    Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

    type stringrequired

    Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

  • ]

  • containerStatuses

    undefined[]

    The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

  • Array [

  • allocatedResources

    object

    AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.

    required
    properties
    containerID string

    ContainerID is the ID of the container in the format '://<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").

    image stringrequired

    Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images.

    imageID stringrequired

    ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.

    lastState

    LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.

    running

    Details about a running container

    startedAt string

    Time at which the container was last (re-)started

    terminated

    Details about a terminated container

    containerID string

    Container's ID in the format '://<container_id>'

    exitCode int32required

    Exit status from the last termination of the container

    finishedAt string

    Time at which the container last terminated

    message string

    Message regarding the last termination of the container

    reason string

    (brief) reason from the last termination of the container

    signal int32

    Signal from the last termination of the container

    startedAt string

    Time at which previous execution of the container started

    waiting

    Details about a waiting container

    message string

    Message regarding why the container is not yet running.

    reason string

    (brief) reason the container is not yet running.

    name stringrequired

    Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.

    ready booleanrequired

    Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field).

    The value is typically used to determine whether a container is ready to accept traffic.

    resources

    Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.

    claims

    undefined[]

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

  • Array [

  • name stringrequired

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

  • ]

  • limits

    object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    required
    properties

    requests

    object

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    required
    properties
    restartCount int32required

    RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.

    started boolean

    Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.

    state

    State holds details about the container's current condition.

    running

    Details about a running container

    startedAt string

    Time at which the container was last (re-)started

    terminated

    Details about a terminated container

    containerID string

    Container's ID in the format '://<container_id>'

    exitCode int32required

    Exit status from the last termination of the container

    finishedAt string

    Time at which the container last terminated

    message string

    Message regarding the last termination of the container

    reason string

    (brief) reason from the last termination of the container

    signal int32

    Signal from the last termination of the container

    startedAt string

    Time at which previous execution of the container started

    waiting

    Details about a waiting container

    message string

    Message regarding why the container is not yet running.

    reason string

    (brief) reason the container is not yet running.

  • ]

  • initContainerStatuses

    undefined[]

    The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status

  • Array [

  • allocatedResources

    object

    AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize.

    required
    properties
    containerID string

    ContainerID is the ID of the container in the format '://<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").

    image stringrequired

    Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images.

    imageID stringrequired

    ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.

    lastState

    LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0.

    running

    Details about a running container

    startedAt string

    Time at which the container was last (re-)started

    terminated

    Details about a terminated container

    containerID string

    Container's ID in the format '://<container_id>'

    exitCode int32required

    Exit status from the last termination of the container

    finishedAt string

    Time at which the container last terminated

    message string

    Message regarding the last termination of the container

    reason string

    (brief) reason from the last termination of the container

    signal int32

    Signal from the last termination of the container

    startedAt string

    Time at which previous execution of the container started

    waiting

    Details about a waiting container

    message string

    Message regarding why the container is not yet running.

    reason string

    (brief) reason the container is not yet running.

    name stringrequired

    Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.

    ready booleanrequired

    Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field).

    The value is typically used to determine whether a container is ready to accept traffic.

    resources

    Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized.

    claims

    undefined[]

    Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container.

    This is an alpha field and requires enabling the DynamicResourceAllocation feature gate.

    This field is immutable. It can only be set for containers.

  • Array [

  • name stringrequired

    Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.

  • ]

  • limits

    object

    Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    required
    properties

    requests

    object

    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. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

    required
    properties
    restartCount int32required

    RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative.

    started boolean

    Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false.

    state

    State holds details about the container's current condition.

    running

    Details about a running container

    startedAt string

    Time at which the container was last (re-)started

    terminated

    Details about a terminated container

    containerID string

    Container's ID in the format '://<container_id>'

    exitCode int32required

    Exit status from the last termination of the container

    finishedAt string

    Time at which the container last terminated

    message string

    Message regarding the last termination of the container

    reason string

    (brief) reason from the last termination of the container

    signal int32

    Signal from the last termination of the container

    startedAt string

    Time at which previous execution of the container started

    waiting

    Details about a waiting container

    message string

    Message regarding why the container is not yet running.

    reason string

    (brief) reason the container is not yet running.

  • ]

  • message string

    A human readable message indicating details about why the pod is in this condition.

    phase string

    The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values:

    Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod.

    More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase

    reason string

    A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'

  • ]

  • podsReady int32

    PodsReady shows how many pods are in a ready state for this component in the environment.

    podsTotal int32

    PodsTotal shows how many pods are present for this component in the environment.

    tls boolean

    TLS will be true if this component has TLS enabled (only relevant if exposed is true)

  • ]

  • deployed boolean

    Deployed will be true if one or more components are deployed to this environment

    deploymentLastChecked string

    DeploymentLastChecked identifies when the deployment status of this app was last checked.

    detail string
    dnsZone string

    DNSZone is the DNS zone which should be used for this environment.

    dnsZoneDedicated boolean

    DNSZoneDedicated will be true if the DNS zone provided is dedicated to this specific appenv.

    hostEnv

    HostEnv provides details about where this app env is hosted

    accountIdentifier string

    AccountIdentifier is the identifier of the cloud account/project/subscription in which the cluster hosting this environment is located.

    cloudAccessConfigRef

    CloudAccessConfigRef is a reference to the cloud access config that the host cluster for this environment is using.

    name stringrequired
    workspace string
    clusterDomain string

    ClusterDomain is the full domain delegated to the host cluster of this environment. This is useful to understand how wildcard certificates and DNS entries can be generated. Application components should use DNSZone, not ClusterDomain, as their suffix.

    clusterRef

    ClusterRef is a reference to the cluster hosting this environment

    name stringrequired
    workspace string

    namespaceClaimRef

    NamespaceClaimRef is a reference to the namespace claim for this environment

    name stringrequired
    workspace string

    ingressClasses

    undefined[]

    IngressClasses are the ingress classes which can be used in the app env

  • Array [

  • class stringrequired

    Class is the name of the ingress class

    namespace string

    Namespace is the namespace the ingress controller is in

  • ]

  • lastReconcile

    generation int64required
    time stringrequired

    lastSuccess

    generation int64required
    time stringrequired
    message string

    obsoleteResources

    undefined[]

  • Array [

  • kind stringrequired
    name stringrequired
  • ]

  • ownedResources

    cloudResources

    undefined[]

  • Array [

  • cloud string
    id string
    name string
    type string
  • ]

  • wayfinderResources

    undefined[]

  • Array [

  • kind string
    name string
    workspace string
  • ]

  • pendingSince

    generation int64required
    time stringrequired
    status stringrequired
    wayfinderVersion string
Loading...