Skip to main content
Version: 1.4

Custom Resource Definitions

Packages

core.appvia.io/v1alpha1

Package v1 contains the core api resources

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

    CommonStatus

    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.

    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 account is inaccessible.

    obsoleteResources
    ObsoleteResourceList

    ObsoleteResources contains a list of resources that are marked for deletion

    CommonStatusAware

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

    Component

    Component the state of a component of the resource

    FieldDescription
    name
    string

    Name is the name of the component

    status
    Status

    Status is the status of the component

    message
    string

    Message is a human readable message on the status of the component

    detail
    string

    Detail is additional details on the error is any

    resource
    Ownership

    Resource is a reference to the resource

    Components ([]*github.com/appvia/wayfinder/pkg/apis/core/v1alpha1.Component)

    Components is a collection child components for a resource

    Condition

    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’.

    ConditionType (string)

    (Appears on: 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

    Conditions ([]github.com/appvia/wayfinder/pkg/apis/core/v1alpha1.Condition)

    (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

    LastReconcileStatus

    (Appears on: CommonStatus)

    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

    Object

    Object is the standard interface implemented by Wayfinder CRDs

    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

    Ownership

    (Appears on: Component, 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

    ResourceAllocation

    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)

    (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

    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

    Status (string)

    (Appears on: CommonStatus, Component)

    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

    "Creating"

    CreatingStatus indicate we are creating a 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

    "Success"

    SuccessStatus is a successful resource

    "Unknown"

    Unknown is an unknown status

    "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

    WorkspaceKey (string)

    (Appears on: WorkspaceCostSummary, 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/pkg/apis/core/v1alpha1.WorkspaceKey)

    (Appears on: ResourceAllocation)

    WorkspaceKeys is a set of workspace keys

    costs.appvia.io/v1alpha1

    Package v1alpha1 contains API Schema definitions for the cost v1alpha1 API group

    Resource Types:

      Account

      Account represents an account

      FieldDescription
      workspaceIdentifier
      string

      WorkspaceIdentifier is the unique identifier for the workspace that owns this asset

      assetIdentifier
      string

      AssetIdentifier is the unique identifier for this asset

      name
      string

      Name is the name of the resource in wayfinder, for reference

      provider
      string

      Provider is the cloud provider who provides this resource

      account
      string

      Provider is the identifier for this account in the providers

      Asset

      Asset represents a resource known to Wayfinder which a cost provider should provide costs data for

      FieldDescription
      tags
      map[string]string

      Tags are a set of tags which can be used to identify this asset

      workspaceIdentifier
      string

      WorkspaceIdentifier is the unique identifier for the workspace that owns this asset

      assetIdentifier
      string

      AssetIdentifier is the unique identifier for this asset

      name
      string

      Name is the name of the resource in wayfinder, for reference

      provider
      string

      Provider is the cloud provider who provides this resource

      AssetCost

      AssetCost defines the details about a cost related to a piece of infrastructure deployed by Wayfinder for a workspace. It is expected that any asset may have multiple AssetCosts covering a specific time period to represent the different charges levied by the provider for that piece of infrastructure.

      FieldDescription
      costIdentifier
      string

      CostIdentifier is the unique identifer for this line of cost data - cost providers must ensure that if a cost line item is updated, it has the same identifier, and that different line items have unique cost identifiers for a given AssetIdentifier. If a cost provider provides immutable cost entries, i.e. they will never be updated, then this can be left blank and Wayfinder will assign a unique identifier.

      assetIdentifier
      string

      AssetIdentifier is the unique identifier assigned to the resource this cost applies to, e.g. the unique cluster ID, etc.

      workspaceIdentifier
      string

      WorkspaceIdentifier is the unique identifier for the workspace this resource belongs to.

      cost
      int64

      Cost is the actual incurred cost total cost for this piece of infrastructure for the specified time period in microdollars

      usageStartTime
      Kubernetes meta/v1.Time

      UsageStartTime indicates the start of the period this cost is applicable for

      usageEndTime
      Kubernetes meta/v1.Time

      UsageEndTime indicates the end of the period this cost is applicable for

      usageType
      string

      UsageType is the provider-specific code or title for this type of usage (e.g. a SKU or similar)

      description
      string

      Description identifies the type of cost this line item refers to

      usageAmount
      string

      UsageAmount is the quantity of the resource used (e.g. amount of storage)

      usageUnit
      string

      UsageUnit is the unit that UsageAmount is expressed in (e.g. seconds, gibibytes, etc)

      provider
      string

      Provider indicates which cloud provider this cost relates to

      account
      string

      Account indicates which account / project / subscription this cost relates to

      invoice
      string

      Invoice is the invoice on which this cost was billed (in the format YYYYMM, e.g. 202008 for August 2020)

      retrievedAt
      Kubernetes meta/v1.Time

      RetrievedAt is the time at which this cost item was retrieved/refreshed from the provider

      AssetCostSummary

      AssetCostSummary represents the total cost known to wayfinder for an asset (over a period of time)

      FieldDescription
      assetIdentifier
      string

      AssetIdentifier is the unique identifier assigned to the resource this cost applies to, e.g. the unique cluster ID, etc.

      workspaceIdentifier
      string

      WorkspaceIdentifier is the unique identifier for the workspaice this resource belongs to.

      assetName
      string

      AssetName is the name of the asset these costs relate to

      assetType
      string

      AssetType is the type of the asset these costs relate to

      provider
      string

      Provider is the cloud provider who provides this assset

      details
      []*github.com/appvia/wayfinder/pkg/apis/costs/v1alpha1.AssetCost

      Details provides the individual cost line items that make up this summary

      CostSummary
      CostSummary

      Continent

      Continent is a geographical grouping of regions

      FieldDescription
      name
      string
      regions
      []Region

      CostEstimate

      CostEstimate defines the result of the cost estimation

      FieldDescription
      minCost
      int64

      MinCost is the minimum hourly cost estimate in microdollars

      typicalCost
      int64

      TypicalCost is the expected / likely hourly cost estimate in microdollars

      maxCost
      int64

      MaxCost is the estimated upper limit of the hourly cost in microdollars

      costElements
      []CostEstimateElement

      CostElements provides details of the different components which make up this cost estimate

      preparedAt
      Kubernetes meta/v1.Time

      PreparedAt indicates the time this estimate was prepared

      CostEstimateElement

      (Appears on: CostEstimate)

      CostEstimateElement represents a logical component which has an associated cost

      FieldDescription
      name
      string

      Name is the name of this component

      minCost
      int64

      MinCost is the minimum hourly cost estimate of this component in microdollars

      typicalCost
      int64

      TypicalCost is the expected / likely hourly cost estimate of this component in microdollars

      maxCost
      int64

      MaxCost is the estimated upper limit of the hourly cost of this component in microdollars

      CostSummary

      (Appears on: AssetCostSummary, OverallCostSummary, WorkspaceCostSummary)

      CostSummary represents a total cost over a period of time

      FieldDescription
      cost
      int64

      Cost is the actual incurred cost total cost for the specified time period in microdollars

      usageStartTime
      Kubernetes meta/v1.Time

      StartTime indicates the start of the period this summary includes costs for

      usageEndTime
      Kubernetes meta/v1.Time

      EndTime indicates the end of the period this summary includes costs for

      InstanceType

      InstanceType is an available compute type from a cloud provider

      FieldDescription
      category
      string

      Category is the classification of this instance type

      name
      string

      Name is the unique identifier of this instance type

      prices
      map[github.com/appvia/wayfinder/pkg/apis/costs/v1alpha1.PriceType]int64

      Prices gives the price of this instance type in microdollars per hour for the given price type

      mCpus
      int64

      MCpus is the number of milliCPUs assigned to this instance type

      mem
      int64

      Mem is the amount of memory, expressed in milli-GiBs, assigned to this instance type

      KubernetesDetails

      KubernetesDetails is the set of cost and version information for the Kubernetes service on a given provider

      FieldDescription
      refreshed
      Kubernetes meta/v1.Time
      exposedServiceCost
      int64

      ExposedServiceCost is the cost in microdollars per hour of each exposed service

      controlPlaneCost
      int64

      ControlPlaneCost is the cost in microdollars per hour of the K8S control plane on this provider

      supportedVersions
      []string

      SupportedVersions is the list of currently-supported K8S versions on this provider

      OverallCostSummary

      OverallCostSummary represents the total costs known to wayfinder over a period of time, and acts as a container for WorkspaceCostSummaries

      PriceType (string)

      PriceType is the possible types of prices for cloud infrastructure

      ValueDescription

      "OnDemand"

      PriceTypeOnDemand is the normal ‘rack’ price for a piece of infrastructure

      "PreEmptible"

      PriceTypePreEmptible is the fixed discounted price which you can use a piece of infrastructure for subject to availability and early termination

      "Spot"

      PriceTypeSpot is the variable price which you may be able to use a piece of infrastructure for

      Region

      (Appears on: Continent)

      Region is a specific cloud provider region

      FieldDescription
      id
      string
      name
      string
      zones
      []string

      WorkspaceCostSummary

      WorkspaceCostSummary represents the total cost known to wayfinder for a workspace (over a period of time)

      FieldDescription
      workspaceIdentifier
      string

      WorkspaceIdentifier is the unique identifier for the workspace these costs belongs to.

      workspace
      WorkspaceKey

      Workspace is the key of the workspace that these costs belong to

      assetCosts
      []*github.com/appvia/wayfinder/pkg/apis/costs/v1alpha1.AssetCostSummary

      AssetCosts gives the detail of the assets which make up this workspace cost

      CostSummary
      CostSummary

      security.appvia.io/v1alpha1

      Package v1alpha1 contains API Schema definitions for the security v1alpha1 API group

      Resource Types:

      SecurityOverview

      SecurityOverview contains a report about the current state of Wayfinder or a workspace

      FieldDescription
      apiVersion
      string
      security.appvia.io/v1alpha1
      kind
      string
      SecurityOverview
      metadata
      Kubernetes meta/v1.ObjectMeta
      Refer to the Kubernetes API documentation for the fields of the metadata field.
      spec
      SecurityOverviewSpec
      workspace
      WorkspaceKey

      Workspace will be populated with the workspace key if this report is about a workspace, else unpopulated for a report for the whole of Wayfinder

      openIssueCounts
      map[github.com/appvia/wayfinder/pkg/apis/security/v1alpha1.RuleStatus]uint64

      OpenIssueCounts informs how many issues of each rule status exist currently

      resources
      []SecurityResourceOverview

      Resources contains summaries of the open issues for each resource

      SecurityRule

      SecurityRule contains the definition of a security rule

      FieldDescription
      apiVersion
      string
      security.appvia.io/v1alpha1
      kind
      string
      SecurityRule
      metadata
      Kubernetes meta/v1.ObjectMeta
      Refer to the Kubernetes API documentation for the fields of the metadata field.
      spec
      SecurityRuleSpec
      code
      string

      Code is the unique identifier of this rule

      name
      string

      Name is the human-readable name of this rule

      description
      string

      Description is the markdown-formatted extended description of this rule.

      appliesTo
      []string

      AppliesTo is the list of resource types (e.g. Plan, Cluster) that this rule is applicable for

      SecurityScanResult

      SecurityScanResult contains the result of a scan against all registered rules

      FieldDescription
      apiVersion
      string
      security.appvia.io/v1alpha1
      kind
      string
      SecurityScanResult
      metadata
      Kubernetes meta/v1.ObjectMeta
      Refer to the Kubernetes API documentation for the fields of the metadata field.
      spec
      SecurityScanResultSpec
      id
      uint64

      ID is the ID of this scan result in the data store

      resource
      Ownership

      Resource is a reference to the group/version/kind/namespace/name of the resource scanned by this scan

      owningWorkspace
      string

      OwningWorkspace is the name of the workspace that owns this resource, will be empty if it is a non-workspace resource.

      checkedAt
      Kubernetes meta/v1.Time

      CheckedAt is the timestamp this result was determined

      archivedAt
      Kubernetes meta/v1.Time

      ArchivedAt is the timestamp this result was superceded by a later scan - if ArchivedAt.IsZero() is true this is the most recent scan.

      overallStatus
      RuleStatus

      OverallStatus indicates the worst-case status of the rules checked in this scan

      results
      []*github.com/appvia/wayfinder/pkg/apis/security/v1alpha1.SecurityScanRuleResult

      Results are the underlying results of the individual rules run as part of this scan

      RuleStatus (string)

      (Appears on: SecurityResourceOverview, SecurityScanResultSpec, SecurityScanRuleResult)

      RuleStatus values represent the possible status of compliance with a security rule.

      ValueDescription

      "Compliant"

      Compliant indicates that this target is fully compliant with the specified rule.

      "Failure"

      Failure indicates that this target is uncompliant in a significant way and should be mitigated. This would typically be used for rules where compliance is considered to be vital to a well-run cluster.

      "Warning"

      Warning indicates that this target is uncompliant in such a way that consideration should be made as to whether this should be remediated. This would typically be used for best practice considerations, where not being compliant isn’t necessarily a critical issue.

      SecurityOverviewSpec

      (Appears on: SecurityOverview)

      SecurityOverviewSpec shows the overall current security posture of Wayfinder or a workspace

      FieldDescription
      workspace
      WorkspaceKey

      Workspace will be populated with the workspace key if this report is about a workspace, else unpopulated for a report for the whole of Wayfinder

      openIssueCounts
      map[github.com/appvia/wayfinder/pkg/apis/security/v1alpha1.RuleStatus]uint64

      OpenIssueCounts informs how many issues of each rule status exist currently

      resources
      []SecurityResourceOverview

      Resources contains summaries of the open issues for each resource

      SecurityResourceOverview

      (Appears on: SecurityOverviewSpec)

      SecurityResourceOverview provides an overview of the open issue counts for a resource

      FieldDescription
      resource
      Ownership

      Resource is a reference to the group/version/kind/namespace/name of the resource scanned by this scan

      lastChecked
      Kubernetes meta/v1.Time

      LastChecked is the timestamp this resource was last scanned

      overallStatus
      RuleStatus

      OverallStatus is the overall status of this resource

      openIssueCounts
      map[github.com/appvia/wayfinder/pkg/apis/security/v1alpha1.RuleStatus]uint64

      OpenIssueCounts is the summary of open issues for this resource

      SecurityRuleSpec

      (Appears on: SecurityRule)

      SecurityRuleSpec specifies the details of a security rule

      FieldDescription
      code
      string

      Code is the unique identifier of this rule

      name
      string

      Name is the human-readable name of this rule

      description
      string

      Description is the markdown-formatted extended description of this rule.

      appliesTo
      []string

      AppliesTo is the list of resource types (e.g. Plan, Cluster) that this rule is applicable for

      SecurityScanResultSpec

      (Appears on: SecurityScanResult)

      SecurityScanResultSpec shows the overall result of a scan against all registered rules

      FieldDescription
      id
      uint64

      ID is the ID of this scan result in the data store

      resource
      Ownership

      Resource is a reference to the group/version/kind/namespace/name of the resource scanned by this scan

      owningWorkspace
      string

      OwningWorkspace is the name of the workspace that owns this resource, will be empty if it is a non-workspace resource.

      checkedAt
      Kubernetes meta/v1.Time

      CheckedAt is the timestamp this result was determined

      archivedAt
      Kubernetes meta/v1.Time

      ArchivedAt is the timestamp this result was superceded by a later scan - if ArchivedAt.IsZero() is true this is the most recent scan.

      overallStatus
      RuleStatus

      OverallStatus indicates the worst-case status of the rules checked in this scan

      results
      []*github.com/appvia/wayfinder/pkg/apis/security/v1alpha1.SecurityScanRuleResult

      Results are the underlying results of the individual rules run as part of this scan

      SecurityScanRuleResult

      SecurityScanRuleResult represents the compliance status of a target with respect to a specific security rule.

      FieldDescription
      ruleCode
      string

      RuleCode indicates the rule that this result relates to

      status
      RuleStatus

      Status indicates the compliance of the target with this rule

      message
      string

      Message provides additional information about the status of this rule on this target, if applicable

      checkedAt
      Kubernetes meta/v1.Time

      CheckedAt is the timestamp this result was determined

      This page was automatically generated with gen-crd-api-reference-docs