Skip to main content

Returns the root context for an application component for an app environment

GET 

/api/v2/workspaces/:workspace/template/context/app/:appenv/:component

Returns the root context for an application component for an app environment

Request

Path Parameters

    workspace stringrequired

    Workspace to use

    appenv stringrequired

    The application environment name

    component stringrequired

    The application component name

Responses

The template context for an app

Schema

    App

    AppEnv

    required

    Name stringrequired
    Namespace stringrequired

    Component

    required

    CloudResourceTags

    object

    property name* string
    Inputs object
    Name stringrequired

    WorkloadIdentity

    PodLabels

    object

    property name* string

    ServiceAccountAnnotations

    object

    property name* string
    ServiceAccountName stringrequired

    obj

    required

    Component represents an application you are planning to use Wayfinder to serve environments for.

    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

    AppComponentSpec defines the specification of the app

    application stringrequired

    Application is the name of the application the component is a part of

    cloudResource

    CloudResource defines the settings for a cloud resource component, required if Type is CloudResource

    plan stringrequired

    Plan identifies the cloud resource plan to use for this cloud resource

    planVersion string

    PlanVersion is the version of the cloud resource plan to use for this cloud resource

    variables object

    Variables is a set of variables to provide to the associated Terraform module when applying. This will be validated against the policy on the specified plan, and override any values provided in that plan.

    variablesFrom

    undefined[]

    VariablesFrom allows variables to be overwritten from other sources, such as AppEnv vars.

  • Array [

  • fromAppEnv

    FromAppEnv gets the value from a named variable on the appenv being deployed to

    default string

    Default is a default value to use if the appenv does not define this variable. If this is unspecified, deploying to an appenv will cause a validation error if the appenv does not define a value for this variable.

    name stringrequired

    Name is the name of variable on the appenv

    name stringrequired

    Name is the name of the variable in the cloud resource variables to overwrite.

  • ]

  • container

    Container defines the settings for a container component, required if Type is Container

    containers

    undefined[]

    Containers defines the settings for a container component, required if Type is Container

  • Array [

  • args string[]

    Args defines the args of a command

    command string[]

    Command defines a command

    env

    undefined[]

    Env is a set of environment variables to expose in this container

  • Array [

  • fromAppEnv

    FromAppEnv gets the value from a named variable on the appenv being deployed to

    default string

    Default is a default value to use if the appenv does not define this variable. If this is unspecified, deploying to an appenv will cause a validation error if the appenv does not define a value for this variable.

    name stringrequired

    Name is the name of variable on the appenv

    fromCloudResourceOutput

    FromCloudResourceOutput gets the value from a dependent cloud resource component's outputs

    componentName stringrequired

    ComponentName is the name of another component in this application representing the value

    output stringrequired

    Output is the name of the environment variable in the cloud resource outputs that you want as the value of the environment variable

    fromSecret

    FromSecret gets the value from a secret

    key stringrequired

    Key is the key in the secret

    name stringrequired

    Name is the name of the secret

    name stringrequired

    Name is the name of the environment variable to set in the container

    value string

    Value is a hard-coded value that this environment variable should always have

  • ]

  • image stringrequired

    Image is the fully-specified container image to use for this component

    name string

    Name is a human readable name for the container

    ports

    undefined[]

    Ports are the ports this component exposes to other components or for external traffic

  • Array [

  • containerPort int32required

    Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.

    expose boolean

    Expose defines whether the port is exposed on the service

    hostIP string

    What host IP to bind the external port to.

    hostPort int32

    Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.

    name string

    If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.

    protocol string

    Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

  • ]

  • securityContext

    SecurityContext defines the security context of the container

    capabilities

    Capabilities describes the Linux capabilities that should be added or removed from the container. If this field is omitted, Wayfinder will explicitly set the capabilities to drop all.

    add string[]

    Added capabilities

    drop string[]

    Removed capabilities

    runAsGroup int64

    The GID to run the entrypoint of the container process. If unset, Wayfinder will provide a default non-root GID. If you need to run as root, you must set RunAsNonRoot to false and RunAsGroup to 0.

    Setting this to 0 will fail on deployment if 'Restricted' pod security standard is enforced.

    runAsNonRoot boolean

    RunAsNonRoot indicates that the container must run as a non-root user. If this is unspecified Wayfinder defaults it to true.

    If unset or set to true Kubernetes will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does.

    If set explicitly to false, no such validation will be performed, allowing the container to run as root.

    Setting this to false will fail on deployment if 'Restricted' pod security standard is enforced.

    runAsUser int64

    RunAsUser is the UID to run the entrypoint of the container process. If unset, Wayfinder will provide a default non-root UID. If you need to run as root, you must set RunAsNonRoot to false and RunAsUser to 0.

    Setting this to 0 will fail on deployment if 'Restricted' pod security standard is enforced.

  • ]

  • deploymentAnnotations

    object

    DeploymentAnnotations are the annotations to apply to the deployment manifest specifically

    property name* string

    expose

    Expose makes this component available outside the cluster by creating an ingress for it

    container stringrequired

    Container is the name of the container to expose

    port int32required

    Port is the port of the container to expose

    imagePullSecrets

    undefined[]

    ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling down images

  • Array [

  • name string

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

  • ]

  • replicas int32

    Replicas defines the number of pods to be created, only used if Type is Container

    securityContext

    SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field.

    fsGroup int64

    FSGroup is a special supplemental group that applies to all containers in a pod. If unset, Wayfinder will provide a default non-root FS group.

    tls boolean

    TLS ensures that the component is exposed with an HTTPS TLS certificate (only relevant if expose is true)

    whitelist string[]

    Whitelist, if set, will restrict access to the specified IP ranges, specified in CIDR notation (only relevant if expose is true)

    dependsOn string[]

    DependsOn is a list of other components that this component depends on - e.g. if this is a container component and needs access to the outputs of a cloud resource, place the name of the cloud resource component here.

    key string

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

    labels

    object

    Labels are the labels to apply to all generated manifests

    property name* string
    name stringrequired

    Name is the unique name for this component within the application.

    type stringrequired

    Type is the component type

    status

    AppComponentStatus defines the status of an application

    cloudResourcesCreated boolean

    conditions

    undefined[]

  • Array [

  • 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[]

  • 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
    Name stringrequired

    CloudAccessConfig

    required

    AWS

    Account string

    Azure

    Subscription string
    Tenant string
    Cloud stringrequired

    GCP

    Project string
    Name stringrequired

    Cluster

    required

    AWS

    Encryption

    KMSKeyAlias string
    KMSKeyID string
    Name stringrequired
    OIDC string

    Azure

    ClusterPrincipalId string
    InfraResourceGroupName string
    Name stringrequired
    Cloud stringrequired

    DNSZones

    undefined[]

    required

  • Array [

  • AWS

    Account stringrequired
    Region stringrequired

    Azure

    ResourceGroup stringrequired
    Subscription stringrequired
    Tenant stringrequired
    Domain stringrequired

    GCP

    Project stringrequired
    Private booleanrequired
    ZoneID stringrequired
  • ]

  • DefaultDomain string

    GCP

    Name stringrequired
    Name stringrequired

    Network

    AWS

    AccountID string
    AvailabilityZoneIDs string[]
    AvailabilityZoneNames string[]
    IPv4EgressAddresses string[]
    PrivateIPV4Addresses string[]
    PrivateSubnetIDs string[]
    PublicIPV4Addresses string[]
    PublicSubnetIDs string[]
    SecurityGroupIDs string[]
    VPCID string

    Azure

    SubnetIDs string[]
    VirtualNetworkID string

    GCP

    Gateways

    undefined[]

  • Array [

  • Addresses string[]
    Location string
    Name string
  • ]

  • Name string
    NetworkRef string

    Packages

    object

    required
    properties
    Region stringrequired
    Version stringrequired
    InstanceIdentifier stringrequired

    Package

    Name stringrequired

    WorkloadIdentity

    PodLabels

    object

    property name* string

    ServiceAccountAnnotations

    object

    property name* string
    ServiceAccountName stringrequired

    Stage

    required

    Name stringrequired

    Workspace

    required

    Key stringrequired
Loading...