Skip to main content
Version: 1.3

Introduction to Wayfinder CRDs

Custom Resource Definitions (CRDs) provide a way to extend the Kubernetes API. Kubernetes has several built-in resources such as pods and deployments. A CRD provides a specification for an additional custom Kubernetes resource.

Wayfinder installs custom resources into the kubernetes API to provide specific functionality. From these, you can create custom objects in yaml based on the CRD specification, and then apply the object to Wayfinder. Once you create and apply these objects, you can manage them using the Kubernetes CLI (kubectl) and the Wayfinder CLI (wf). For users comfortable with creating instances of Kubernetes resources in yaml, the CRDs can be used for automations, creating custom policies, or extending Wayfinder to suit your needs.

See the API Reference for descriptions of Wayfinder CRDs.

For more information, see Create custom objects in the Kubernetes documentation.

Creating and applying a custom object in Wayfinder

Wayfinder CRDs let you create custom object instances.

Example of creating an object instance

Here is a simple example of how an object instance is related to a CRD. (See more complex examples below.)

The User object specification defines the fields required for an instance of that object. To create a user object based on the specification, you will provide:

  • apiVersion
  • kind
  • metadata
  • spec: email, username

Here's example yaml for the above:

apiVersion: org.appvia.io/v1alpha1
kind: User
metadata:
name: jane
spec:
username: jane
email: jane.wong@appvia.io

After saving this file, you now must apply it to Wayfinder. See below.

Apply the object in Wayfinder

When you create a custom object instance as in the example above, you must apply it to Wayfinder before you can manage that object using the Wayfinder and Kubernetes CLIs (wf and kubectl).

To apply a custom object to Wayfinder:

  1. Create the object definition in a yaml file. See the example above.

  2. Apply the file using the CLI:

    wf apply -f PATH-TO-FILE.yaml

View details and status of an object

You can view details and status of any object/resource in Wayfinder.

To list and view details of objects:

  1. To list objects/resources in Wayfinder, use the command:

    wf get OBJECT

    Examples:

    • wf get clusters lists all clusters in your current workspace.
    • wf get users lists all users in your current workspace.
  2. To view details and status of an object in Wayfinder, add -o yaml to the command:

    wf get OBJECT OBJECT-NAME -o yaml

    Examples:

    • wf get cluster eks-dev -o yaml returns the details and status of the eks-dev cluster in your current workspace.
    • wf get plan aks-nonprod -o yaml returns the details of the aks-nonprod cluster plan.

Example use cases

Here are some examples of using CRDs in Wayfinder.

Apply custom security policies

You can write custom security policies using Wayfinder's Policy CRD. Whether you want to control access or resource usage across Wayfinder, or a). These links walk you through:

Add an RBAC role

Wayfinder comes with some roles pre-defined, such as cluster.admin, which have a set of permissions. You can use the PolicyPlan CRD to add more roles if needed.

For an example, see:

Define network peering

You can define how you want your networks to be wired up. The links below provide example peering definitions, which use the PeeringRule CRD for the following network topologies:

See also Overview of Peering.