Skip to main content

core.appvia.io/v1alpha1

Package v1alpha1 contains the core api resources

Exported Resource Types​

    Internal Resource Types​

    ActionSelector​

    ActionSelector is used to filter on the operation type

    FieldDescription
    verbs

    []string

    Allocatable​

    Allocatable must be implemented by CRDs which are allocateable

    CloudAccessConfigRef​

    (Appears on: AppEnvHostEnv, AppEnvSpec, CloudResourceReferenceSpec, ClusterSpec, AWSVPCReference, DNSZoneSpec, AWSVPCReference, DNSZoneSpec)

    Mark 2023-10-27: if only I understood go generics better… fml for this repetition… CloudAccessConfigRef is a reference to a cloud access config

    FieldDescription
    workspace
    WorkspaceKey

    Workspace identifies the workspace in which this item exists. If empty, assume the same workspace as the object holding the reference.

    name

    string

    Name is the object name of the referenced item

    CloudAccessConfigValuesFrom​

    (Appears on: ValuesFrom)

    CloudAccessConfigValuesFrom is used to reference a values from an associated cloud access config

    FieldDescription
    apiVersion

    string

    APIVersion is the API version of the cloud access config resource

    Value
    Value

    (Members of Value are embedded into this type.)

    Value is the value to be injected

    CloudResource​

    (Appears on: OwnedResources)

    CloudResource is a reference to a resource in the given cloud

    FieldDescription
    name

    string

    Name is the name of the resource in the cloud

    id

    string

    ID is the full cloud ID of the resource, e.g. the full ARN, Azure Resource ID, etc.

    type

    string

    Type is the type of resource e.g. AzureManagedIdentity, AWSIAMRole

    cloud

    string

    Cloud is the cloud where the resource exists

    ClusterCapability​

    FieldDescription
    name

    string

    Name is the name of the capability

    status
    CommonStatus
    status
    Status

    Status is the overall status of the resource. This will shortly become required, hence no omit empty here.

    message

    string

    Message is a description of the current status

    detail

    string

    		(Optional)

    Detail is any additional human-readable detail to understand the current status, for example, the full underlying error which caused an issue

    conditions
    Conditions

    Conditions represents the observations of the resource’s current state.

    pendingSince
    LastReconcileStatus

    PendingSince describes the generation and time of the first reconciliation with a pending status since the last successful reconcile for this generation

    lastReconcile
    LastReconcileStatus

    LastReconcile describes the generation and time of the last reconciliation

    lastSuccess
    LastReconcileStatus

    LastSuccess descibes the generation and time of the last reconciliation which resulted in a Success status

    cloudResourcesCreated

    bool

    CloudResourcesCreated indicates that at some point, this resource has successfully created one or more cloud resources. This is used when deleting to decide whether to fail or ignore if a related cloud access config is inaccessible.

    obsoleteResources
    ObsoleteResourceList

    ObsoleteResources contains a list of resources that are marked for deletion

    wayfinderVersion

    string

    WayfinderVersion is the version of Wayfinder that last reconciled this resource

    ownedResources
    OwnedResources

    OwnedResources lists the child resources (in Wayfinder and in cloud) owned by this resource

    spec
    ClusterCapabilitySpec
    description

    string

    Description is the description of the capability

    enabled

    bool

    Enabled states if capability is enabled

    readOnly

    bool

    ReadOnly states if the capability can/cannot be enabled

    -

    string

    EnableLabel is internal struct to store the label with which addon should be enabled. Not marshaled in API responses

    ClusterCapabilitySpec​

    (Appears on: ClusterCapability)

    ClusterCapabilitySpec defines the state of the capability on the cluster

    FieldDescription
    description

    string

    Description is the description of the capability

    enabled

    bool

    Enabled states if capability is enabled

    readOnly

    bool

    ReadOnly states if the capability can/cannot be enabled

    -

    string

    EnableLabel is internal struct to store the label with which addon should be enabled. Not marshaled in API responses

    ClusterNetworkRef​

    (Appears on: ClusterSpec)

    ClusterNetworkRef is a reference to a cluster network

    FieldDescription
    workspace
    WorkspaceKey

    Workspace identifies the workspace in which this item exists. If empty, assume the same workspace as the object holding the reference.

    name

    string

    Name is the object name of the referenced item

    ClusterPackage​

    FieldDescription
    name

    string

    Name is the name of the package version

    status
    CommonStatus
    status
    Status

    Status is the overall status of the resource. This will shortly become required, hence no omit empty here.

    message

    string

    Message is a description of the current status

    detail

    string

    		(Optional)

    Detail is any additional human-readable detail to understand the current status, for example, the full underlying error which caused an issue

    conditions
    Conditions

    Conditions represents the observations of the resource’s current state.

    pendingSince
    LastReconcileStatus

    PendingSince describes the generation and time of the first reconciliation with a pending status since the last successful reconcile for this generation

    lastReconcile
    LastReconcileStatus

    LastReconcile describes the generation and time of the last reconciliation

    lastSuccess
    LastReconcileStatus

    LastSuccess descibes the generation and time of the last reconciliation which resulted in a Success status

    cloudResourcesCreated

    bool

    CloudResourcesCreated indicates that at some point, this resource has successfully created one or more cloud resources. This is used when deleting to decide whether to fail or ignore if a related cloud access config is inaccessible.

    obsoleteResources
    ObsoleteResourceList

    ObsoleteResources contains a list of resources that are marked for deletion

    wayfinderVersion

    string

    WayfinderVersion is the version of Wayfinder that last reconciled this resource

    ownedResources
    OwnedResources

    OwnedResources lists the child resources (in Wayfinder and in cloud) owned by this resource

    spec
    ClusterPackageSpec
    packageName

    string

    PackageName is the name of the package the version satisfies

    description

    string

    Description is the description of the package

    version

    string

    Version is the semantic version of the package version

    chartName

    string

    ChartName is the name of the underlying helm chart

    chartVersion

    string

    ChartVersion is the version of the underlying helm chart

    installNamespace

    string

    InstallNamespace is the namespace of the cluster in which this chart is (or will be) installed

    ClusterPackageCapability​

    FieldDescription
    exposed

    bool

    Exposed defines whether the package is exposed as a capability

    enabled

    bool

    Enabled states if capability is enabled on the cluster

    readOnly

    bool

    ReadOnly states if the capability can/cannot be enabled

    ClusterPackageSpec​

    (Appears on: ClusterPackage)

    FieldDescription
    packageName

    string

    PackageName is the name of the package the version satisfies

    description

    string

    Description is the description of the package

    version

    string

    Version is the semantic version of the package version

    chartName

    string

    ChartName is the name of the underlying helm chart

    chartVersion

    string

    ChartVersion is the version of the underlying helm chart

    installNamespace

    string

    InstallNamespace is the namespace of the cluster in which this chart is (or will be) installed

    ClusterRef​

    (Appears on: AppEnvHostEnv, ClusterPlanValidationSpec, ClusterPlanValidationStatus)

    ClusterRef is a reference to a cluster

    FieldDescription
    workspace
    WorkspaceKey

    Workspace identifies the workspace in which this item exists. If empty, assume the same workspace as the object holding the reference.

    name

    string

    Name is the object name of the referenced item

    ClusterValuesFrom​

    (Appears on: ValuesFrom)

    ClusterValuesFrom is used to reference a values from an associated cluster

    FieldDescription
    Value
    Value

    (Members of Value are embedded into this type.)

    CommonStatus​

    (Appears on: AppComponentStatus, AppEnvStatus, ApplicationStatus, CloudAccessCheckStatus, CloudAccessConfigStatus, CloudIdentityStatus, WorkloadIdentityStatus, CloudAccessCheckStatus, CloudAccessConfigStatus, CloudIdentityStatus, CloudPermission, CloudResourceReferenceStatus, WorkloadIdentityStatus, CloudResourcePlanStatus, ProvisioningPolicyStatus, CloudResourcePlanStatus, ClusterPlanStatus, ClusterStatus, ContainerRegistryStatus, KubernetesUpdateStatus, NamespaceClaimStatus, NodePoolStatus, NodePoolUpdateStatus, QuotaLimitStatus, ClusterPlanStatus, ClusterPlanValidationStatus, ClusterStatus, ComputeTemplateStatus, CostLimitStatus, ClusterCapability, ClusterPackage, DNSZoneStatus, DNSZoneStatus, DNSZoneStatus, AssignableNetworkStatus, ClusterNetworkPlanStatus, ClusterNetworkStatus, PeeringRuleStatus, PeeringStatus, AccessTokenStatus, ChannelStatus, DefaultWorkspaceGroupStatus, StageStatus, UserStatus, WayfinderGroupStatus, WayfinderRoleBindingStatus, WayfinderRoleStatus, WorkspaceGroupStatus, WorkspaceInvitationStatus, WorkspaceRoleBindingStatus, WorkspaceStatus, PackageReleaseStatus, PackageStatus, PackageUpdateStatus, RepositoryReleaseStatus, RepositoryStatus, PackageReleaseStatus, PackageStatus, PackageUpdateStatus, RepositoryStatus, AccessPolicyStatus, AccessRoleBindingStatus, AccessRoleStatus, ClusterPolicyStatus, GlobalAccessPolicyStatus, GlobalAccessRoleStatus)

    FieldDescription
    status
    Status

    Status is the overall status of the resource. This will shortly become required, hence no omit empty here.

    message

    string

    Message is a description of the current status

    detail

    string

    		(Optional)

    Detail is any additional human-readable detail to understand the current status, for example, the full underlying error which caused an issue

    conditions
    Conditions

    Conditions represents the observations of the resource’s current state.

    pendingSince
    LastReconcileStatus

    PendingSince describes the generation and time of the first reconciliation with a pending status since the last successful reconcile for this generation

    lastReconcile
    LastReconcileStatus

    LastReconcile describes the generation and time of the last reconciliation

    lastSuccess
    LastReconcileStatus

    LastSuccess descibes the generation and time of the last reconciliation which resulted in a Success status

    cloudResourcesCreated

    bool

    CloudResourcesCreated indicates that at some point, this resource has successfully created one or more cloud resources. This is used when deleting to decide whether to fail or ignore if a related cloud access config is inaccessible.

    obsoleteResources
    ObsoleteResourceList

    ObsoleteResources contains a list of resources that are marked for deletion

    wayfinderVersion

    string

    WayfinderVersion is the version of Wayfinder that last reconciled this resource

    ownedResources
    OwnedResources

    OwnedResources lists the child resources (in Wayfinder and in cloud) owned by this resource

    CommonStatusAware​

    CommonStatusAware is implemented by any Wayfinder resource which has the standard Wayfinder common status implementation

    Condition​

    (Appears on: ClusterPackageValidationStatus, ClusterValidationStatus)

    Condition is the current observed condition of some aspect of a resource

    FieldDescription
    type
    ConditionType

    Type of condition in CamelCase or in foo.example.com/CamelCase. — Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

    status
    Kubernetes meta/v1.ConditionStatus

    Status of the condition, one of True, False, Unknown.

    observedGeneration

    int64

    		(Optional)

    ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

    lastTransitionTime
    Kubernetes meta/v1.Time

    LastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

    reason

    string

    Reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

    message

    string

    		(Optional)

    Message is a human readable message indicating details about the transition. This may be an empty string.

    name

    string

    Name is a human-readable name for this condition.

    detail

    string

    		(Optional)

    Detail is any additional human-readable detail to understand this condition, for example, the full underlying error which caused an issue

    negativePolarity

    bool

    		(Optional)

    NegativePolarity indicates this is a ‘normal-false’ condition - i.e. the ‘normal’/‘successful’ status for this condition is metav1.ConditionFalse. This will be the case for conditions such as ‘OutOfMemory’. If unset/false, positive polarity can be assumed - i.e. that metav1.ConditionTrue indicates the ‘normal’/‘successful’ status. This will be the case for conditions such as ‘Deployed’

    ConditionSpec​

    ConditionSpec describes the shape of a condition which will be populated onto the status

    FieldDescription
    Type
    ConditionType

    The PascalCase condition type, e.g. ServiceAvailable or InsufficientCapacity. See ConditionType for the rules on condition types.

    Name

    string

    Name is a human-readable name for this condition, used for UI and CLI reporting / explanation If Name is empty, the Type will be used also as the Name.

    DefaultStatus
    Kubernetes meta/v1.ConditionStatus

    DefaultStatus is the default status - if unset, metav1.ConditionUnknown will be used.

    NegativePolarity

    bool

    NegativePolarity indicates this is a ‘normal-false’ condition - i.e. the ‘normal’/‘successful’ status for this condition is metav1.ConditionFalse. This will be the case for conditions such as ‘OutOfMemory’, ‘Degraded’. If unset/false, positive polarity will be assumed - i.e. that metav1.ConditionTrue indicates the ‘normal’/‘successful’ status. This will be the case for conditions such as ‘Deployed’ or ‘Available’.

    ConditionSpecs​

    ([]github.com/appvia/wayfinder/tmpcrdref/pkg/apis/core/v1alpha1.ConditionSpec alias)

    ConditionType​

    (string alias) (Appears on: ConditionSuccess, Condition, ConditionSpec)

    ConditionType defines a type of a condition in PascalCase or in foo.example.com/PascalCase — Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)

    ValueDescription
    "Ready"

    ConditionReady describes the overall status of the resource. All Wayfinder resources should set ConditionReady

    "Paused"

    Conditions​

    ([]github.com/appvia/wayfinder/tmpcrdref/pkg/apis/core/v1alpha1.Condition alias) (Appears on: CommonStatus)

    ConfigurationFromSource​

    FieldDescription
    path

    string

    Path is the JSON path of the configuration parameter Examples: “field”, “map_field.value”, “array_field.0”, “array_field.0.value” To append a value to an existing array: “array_field.-1” To reference a numeric key on a map: “map_field.:123.value”

    secretKeyRef
    OptionalSecretKeySelector

    SecretKeyRef is a reference to a key in a secret

    DNSZoneRef​

    (Appears on: WorkspaceDNSZoneSpec, WorkspaceDNSZoneSpec)

    DNSZoneRef is a reference to a global or workspaced DNS zone

    FieldDescription
    workspace
    WorkspaceKey

    Workspace identifies the workspace in which this item exists. If empty, this refers to a GlobalDNSZone, if populated, a workspaced DNSZone

    name

    string

    Name is the object name of the referenced item

    DomainValuesFrom​

    (Appears on: ValuesFrom)

    DomainValuesFrom is used to reference the default domain attached to the cluster We support zones with direct mode only. createChildZone will create child zone with same selector with direct mode.

    FieldDescription
    Value
    Value

    (Members of Value are embedded into this type.)

    optional

    bool

    Optional is a flag to indicate if the value is required.

    limit

    int64

    Limit is a flag to indicate if the value is limited to specific number of values

    asArray

    bool

    AsArray places the matching values(s) from the domains into the value as an array. If false, multiple values will be comma-concatenated into a string.

    matchLabels
    Kubernetes meta/v1.LabelSelector

    MatchLabels is used to find one or more specific domain resources for inject - be careful unless intended not to match multiple as we will inject the zone names as an array

    LastReconcileStatus​

    (Appears on: CommonStatus, RoutingTargetStatus)

    FieldDescription
    time
    Kubernetes meta/v1.Time

    Time is the last time the resource was reconciled

    generation

    int64

    Generation is the generation reconciled on the last reconciliation

    NamespaceClaimRef​

    (Appears on: AppEnvHostEnv)

    NamespaceClaimRef is a reference to a namespace claim

    FieldDescription
    workspace
    WorkspaceKey

    Workspace identifies the workspace in which this item exists. If empty, assume the same workspace as the object holding the reference.

    name

    string

    Name is the object name of the referenced item

    Object​

    Object is the standard interface implemented by Wayfinder CRDs

    ObjectVersion​

    (string alias) (Appears on: CloudResourcePlanSpec, ClusterStatus, ClusterPlanSpec, ClusterStatus, PackageRef, PlanRef, PackageSpec, PackageUpdateSpec, PackageUpdateStatus)

    ObjectVersion identifies the version of a versionable resource. Must be a valid semver in the format X.Y.Z. An optional ‘v’ prefix is supported but discouraged. An optional -suffix can be provided; note in semver that 1.0.0 is after 1.0.0-1.

    ObsoleteResource​

    ObsoleteResource is a resource that is marked for deletion

    FieldDescription
    kind
    obsoleteResourceKind

    Kind is the kind of the resource, eg. IAMRole

    name

    string

    Name is the name of the resource, eg. my-iam-role

    OptionalSecretKeySelector​

    (Appears on: ConfigurationFromSource)

    FieldDescription
    SecretKeySelector
    SecretKeySelector

    (Members of SecretKeySelector are embedded into this type.)

    optional

    bool

    Optional controls whether the secret with the given key must exist

    OwnedResources​

    (Appears on: CommonStatus)

    OwnedResources is a reference to the resources created and owned by an object in Wayfinder

    FieldDescription
    wayfinderResources
    []WayfinderResource

    WayfinderResources are resources within wayfinder

    cloudResources
    []CloudResource

    CloudResources are managed resources in the relevant cloud

    Ownership​

    (Appears on: AppEnvSpec, WorkloadIdentitySpec, WorkloadIdentitySpec, ResourceValuesFrom, NamespaceClaimSpec, Networking, QuotaLimitSpec, ResourceValuesFrom, RoutingTargetStatus, UpdateStep, UpdateStepStatus, DNSZoneSpec, FirewallSpec, PeeringSpec, PackageReleaseSpec, RepositoryReleaseSpec, RepositorySpec, PackageReleaseSpec, AccessRoleAssignRequest, AccessRoleAssumeRequest, AccessRoleBindingSpec, SecurityResourceOverview, SecurityScanResultSpec)

    Ownership indicates the ownership of a resource

    FieldDescription
    group

    string

    Group is the api group

    version

    string

    Version is the group version

    kind

    string

    Kind is the name of the resource under the group

    namespace

    string

    Namespace is the location of the object

    name

    string

    Name is name of the resource

    PackageRef​

    (Appears on: ClusterPlanSpec, ClusterPackageValidationStatus, ClusterPlanCluster)

    FieldDescription
    name

    string

    version
    ObjectVersion

    PlanObject​

    PlanObject is the interface that all plan compatible objects must implement

    PlanPolicy​

    (Appears on: PlanSpec)

    PlanPolicy defines possible entries for a spec

    FieldDescription
    editable

    bool

    Editable indicates the entry can or cannot be changed

    enum

    []string

    Enum is a collection of possible values

    max

    int64

    Max is a max to the value

    min

    int64

    Min is a minimum to the value

    path

    string

    Path is the a json path to the value

    pattern

    string

    Pattern is used as regex constraint on the input

    summary

    string

    Summary provides an optional description to the field attribute

    PlanRef​

    (Appears on: ClusterSpec, ClusterUpdateStep, ClusterValidationStatus)

    PlanRef represents a versioned reference to a plan construct

    FieldDescription
    name

    string

    version
    ObjectVersion
    followPublished

    bool

    PlanSpec​

    (Appears on: CloudResourcePlanSpec, ClusterPlanSpec)

    PlanSpec defines the desired state of Plan

    FieldDescription
    allocation
    ResourceAllocation

    Allocation defines one or more workspaces which are permitted to access this plan

    labels

    map[string]string

    Labels is a collection of labels for this plan

    policies
    []PlanPolicy

    Policies are a collection of policies related to the use of the plan

    PlatformSecretRef​

    (string alias) (Appears on: Configuration, TerraformDefinition)

    PlatformSecretRef is a reference to a platform secret

    PublishState​

    (string alias) (Appears on: PublishingState)

    ValueDescription
    "Deprecated"
    "Draft"
    "Published"
    ""

    PublishingState​

    PublishingState conveys the publishing state of a resource

    FieldDescription
    published

    bool

    publishState
    PublishState

    ResourceAllocation​

    (Appears on: ClusterSpec, CostLimitScope, PlanSpec, DNSZoneSpec, GlobalDNSZoneSpec, PeeringRuleFilters)

    ResourceAllocation describes who is allowed to use a resource across workspace boundaries.

    FieldDescription
    type
    ResourceAllocationType

    Type controls which workspaces can use this resource . If ‘none’, this resource cannot be used by workspaces other than the one the resource exists in. ‘all’ allows it to be used by all workspaces, and ‘workspaces’ indicates it can be used by the workspaces listed in the workspaces property.

    workspaces
    WorkspaceKeys

    Workspaces indicates which workspaces can use this resource. Ignored unless type is set to ‘workspaces’.

    ResourceAllocationType​

    (string alias) (Appears on: ResourceAllocation)

    ResourceAllocationType represents the possible types of resource allocation

    ValueDescription
    "all"

    ResourceAllocationAll indicates that the resource can be used by all workspaces

    "none"

    ResourceAllocationNone indicates that the resource can only be used by the workspace that owns it

    "workspaces"

    ResourceAllocationWorkspaces indicates that the resource can be used by a specified set of workspaces

    ResourceSelector​

    ResourceSelector is a resource selector

    FieldDescription
    nonResourceURLs

    []string

    NonResourceURLs are urls which do not map to resources by require some level of policy control

    groups

    []string

    Groups is a collection of api grouprs to filter on

    resources

    []string

    Resources is a collection of resources under those groups

    subresources

    []string

    SubResources is a collection of subresource under the resource type Deprecated field please use resource/subresource format

    resourceNames

    []string

    ResourceNames is a collection of resource names

    labels

    map[string]string

    Labels a collection of labels to filter the resource by

    verbs

    []string

    Verbs are actions on the resources themselves

    ResourceValuesFrom​

    (Appears on: ValuesFrom)

    ResourceValuesFrom is used to define a reference to a resource

    FieldDescription
    Ownership
    Ownership

    (Members of Ownership are embedded into this type.)

    Value
    Value

    (Members of Value are embedded into this type.)

    RoutingStatus​

    (Appears on: ContainerRegistryStatus, PackageStatus, PackageStatus, ClusterPolicyStatus)

    FieldDescription
    routing
    RoutingTargetStatuses

    RoutingTargetStatuses is that

    RoutingStatusAware​

    RoutingStatusAware is implemented by any Wayfinder resource which has the standard Wayfinder routuing status implementation

    RoutingTargetStatus​

    RoutingTargetStatus is the current observed status of a routing action to a target

    FieldDescription
    target
    Ownership
    status
    Status
    error

    string

    		(Optional)
    lastReconcile
    LastReconcileStatus

    LastReconcile describes the generation and time of the last reconciliation

    RoutingTargetStatuses​

    ([]github.com/appvia/wayfinder/tmpcrdref/pkg/apis/core/v1alpha1.RoutingTargetStatus alias) (Appears on: RoutingStatus)

    Scope​

    (Appears on: ProvisioningPolicySpec, CloudResourcePlanSpec, ClusterPlanSpec)

    FieldDescription
    ScopeWorkspace
    ScopeWorkspace

    (Members of ScopeWorkspace are embedded into this type.)

    ScopeWorkspace indicates which workspaces can use this resource.

    ScopeStages
    ScopeStages

    (Members of ScopeStages are embedded into this type.)

    ScopeStages indicates which stages can use this resource.

    ScopeStages​

    (Appears on: Scope)

    FieldDescription
    allStages

    bool

    AllStages indicates all stages can use this resource

    allowedStages

    []string

    AllowedStages indicates which stages can use this resource. only valid if AllStages is false

    ScopeWorkspace​

    (Appears on: ClusterSpec, Scope)

    FieldDescription
    allWorkspaces

    bool

    AllWorkspaces indicates all workspaces can use this resource

    allowedWorkspaces
    WorkspaceKeys

    AllowedWorkspaces indicates which workspaces can use this resource. only valid if All is false

    SecretKeySelector​

    (Appears on: OptionalSecretKeySelector)

    FieldDescription
    name

    string

    Name is the name of the secret

    namespace

    string

    Name is the namespace of the secret

    key

    string

    Key is they data key in the secret

    SecretValuesFrom​

    (Appears on: ValuesFrom)

    SecretValuesFrom is used to define a reference to a secret

    FieldDescription
    SecretReference
    Kubernetes core/v1.SecretReference

    (Members of SecretReference are embedded into this type.)

    Value
    Value

    (Members of Value are embedded into this type.)

    Status​

    (string alias) (Appears on: EKSEncryptionStatus, ClusterPackageValidationStatus, ClusterValidationStatus, EKSEncryptionStatus, CommonStatus, RoutingTargetStatus, UpdateStepStatus)

    Status is the status of a thing

    ValueDescription
    "ActionRequired"

    ActionRequiredStatus indicates that user action is required to remediate the current state of a resource, e.g. a spec value is wrong or some external action needs to be taken

    "Cancelled"

    CancelledStatus indicates that a process that runs to completion was aborted before completion

    "Complete"

    CompleteStatus indicates that a process that runs to completion has been completed N.B. CompleteStatus should only be used for this reason

    "Creating"

    CreatingStatus indicate we are creating a resource

    "DeleteActionRequired"

    DeleteActionRequiredStatus indicates a sitation requiring outside intervention has occurred while attempting to delete the resource

    "DeleteError"

    DeleteErrorStatus indicates an error has occurred while attempting to delete the resource

    "DeleteFailed"

    DeleteFailedStatus indicates that deleting the entity failed

    "Deleted"

    DeletedStatus indicates a deleted entity

    "Deleting"

    DeletingStatus indicates we are deleting the resource

    ""

    EmptyStatus indicates an empty status

    "Error"

    ErrorStatus indicates that a recoverable error happened

    "Failure"

    FailureStatus indicates the resource has failed for one or more reasons

    "Pending"

    PendingStatus indicate we are waiting

    "ReconciliationPaused"

    ReconciliationStartedStatus indicates that the reconciliation is paused

    "Success"

    SuccessStatus is a successful resource

    "Updating"

    UpdatingStatus indicate we are creating a resource

    "Warning"

    WarningStatus indicates are warning

    SubjectSelector​

    SubjectSelector is used to filter down in the caller

    FieldDescription
    subjects

    []string

    Subjects is a collection of subjects / username to filter on

    roles

    []string

    Roles is a collection of roles the user has access to

    groups

    []string

    Groups is a collection of groups the user is a member of

    scopes

    []string

    Scopes is a collection of scopes for the identity

    UpdateObject​

    UpdateObject is the interface that all update compatible objects must implement

    UpdateSpec​

    (Appears on: KubernetesUpdateSpec, NodePoolUpdateSpec, PackageUpdateSpec, PackageUpdateSpec)

    UpdateSpec are the fields required by an update compatible object on the spec

    FieldDescription
    preRequisite
    UpdateStep

    PreRequisite is any steps that can block this update

    awaitingApproval

    bool

    AwaitingApproval specifies that the step is blocked until the user confirms No more reconciliation will be attempted until this is set to false

    nextSteps
    UpdateStep

    Next is the single next steps after this update Not required if there are no further steps Provided as a convenience to allow for a UI to show the next step - E.g. a final manual intervention step could indicate what will happen when the user confirms

    UpdateStatus​

    UpdateStatus are the status fields required by an update compatible object

    FieldDescription
    preRequisite
    UpdateStepStatus

    PreRequisites are the current status of the pre-requisites

    startTime
    Kubernetes meta/v1.Time

    StartTime is the time the update was started Is used to estimate the percentage complete time

    estimatedPercentageComplete

    int

    EstimatedPercentageComplete is the estimated percentage complete of the update - Based on the time from StartTime and a test of actual updates - not optional, will be 0 if not started

    UpdateStep​

    (Appears on: UpdateSpec)

    UpdateStep is the specification of a step in an update plan or a pre-requisite

    FieldDescription
    owner
    Ownership

    Owner is the object (when relevant) that the step is related to

    UpdateStepStatus​

    (Appears on: UpdateStatus)

    UpdateStepStatus is the current observed status of an update step this is for pre-requisites and next steps

    FieldDescription
    owner
    Ownership

    Owner is the object (when relevant) that the step is related to

    status
    Status

    Status is the current status of the step

    error

    string

    Error is the error message if the step failed

    UpdateSteps​

    ([]github.com/appvia/wayfinder/tmpcrdref/pkg/apis/core/v1alpha1.UpdateStep alias)

    UpdateSteps is a list of update steps envisaged to be present on a rollout plan

    Value​

    (Appears on: CloudAccessConfigValuesFrom, ClusterValuesFrom, DomainValuesFrom, ResourceValuesFrom, SecretValuesFrom, ValueFromSecret)

    Value is a default value parameter

    FieldDescription
    path

    string

    Path is the path into the helm values

    specPath

    bool

    SpecPath is the path into the release spec.

    key

    string

    Key is a path into the resource data

    valuePrefix

    string

    ValuePrefix is a prefix which will be prepended to the value patched into the helm values. If specified, this means the value from the key will be coerced to a string

    valueSuffix

    string

    ValueSuffix is a suffix which will be appended to the value patched into the helm values. If specified, this means the value from the key will be coerced to a string

    ValuesFrom​

    (Appears on: PackageSpec, Helm)

    ValuesFrom defines a means to extract a value out of a resource and into the values for an arbitrary destination, such as a helm chart or cloud resource plan

    FieldDescription
    cluster
    ClusterValuesFrom

    Cluster is used to extract a piece of data out of the associated cluster resources and inject into the path defined

    cloudAccessConfig
    CloudAccessConfigValuesFrom

    CloudAccessConfig is used to extract a piece of data out of the cloud access config associated with the cluster and inject into the path defined

    resource
    ResourceValuesFrom

    Resource is used to filter on and extract the details from one of more managed resources in Wayfinder.

    secret
    SecretValuesFrom

    Secret is used to reference a secret in wayfinder

    domain
    DomainValuesFrom

    Domain is used to reference a domains in wayfinder

    Versioned​

    Versioned is the interface implemented by types which are resource versioned

    VersionedObject​

    WayfinderResource​

    (Appears on: OwnedResources)

    WayfinderResource is reference to a resource within wayfinder

    FieldDescription
    kind

    string

    Kind is the kind of resource

    name

    string

    Name is the name of the resource

    workspace
    WorkspaceKey

    Workspace is the workspace of the resource

    WorkspaceKey​

    (string alias) (Appears on: ClusterPlanValidationSpec, CloudAccessConfigRef, ClusterNetworkRef, ClusterRef, DNSZoneRef, NamespaceClaimRef, WayfinderResource, WorkspaceCostSummary, ClusterNetworkPlanClusters, AuditEventSpec, Subject, WorkspaceInvitationSpec, WorkspaceSpec, Subject, SecurityOverviewSpec)

    WorkspaceKey is the unique identifier for a workspace in Wayfinder. Use .Namespace() to convert to the right name for the workspace’s namespace in the management cluster.

    ValueDescription
    "admin"

    AdminWorkspace is the workspace where platform administrative resources live **IMPORTANT: IF THIS VALUE IS CHANGED, ENSURE THAT ui/lib/utils/workspaces.ts IS ALSO UPDATED

    WorkspaceKeys​

    ([]github.com/appvia/wayfinder/tmpcrdref/pkg/apis/core/v1alpha1.WorkspaceKey alias) (Appears on: ResourceAllocation, ScopeWorkspace)

    WorkspaceKeys is a set of workspace keys

    Last updated