provider-aviatrix

module
v0.0.0-...-fae2378 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 4, 2023 License: Apache-2.0

README

Provider Aviatrix

This repository is a work in progress. In the future, it will be the site of a fully supported crossplane provider for configuring Aviatrix Controllers. It is not currently ready for production use, and should be considered to be a pre-alpha level quality.

provider-aviatrix is a Crossplane provider that is built using Upjet code generation tools and exposes XRM-conformant managed resources for the Aviatrix API.

Getting Started

This section is under construction, and not yet functional.

Install the provider by using the following command after changing the image tag to the latest release:

up ctp provider install aviatrix/provider-aviatrix:v0.1.0

Alternatively, you can use declarative installation:

cat <<EOF | kubectl apply -f -
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-aviatrix
spec:
  package: aviatrix/provider-aviatrix:v0.1.0
EOF

Notice that in this example Provider resource is referencing ControllerConfig with debug enabled.

You can see the API reference here.

Developing

Run code-generation pipeline:

go run cmd/generator/main.go "$PWD"

Run against a Kubernetes cluster:

make run

Build, push, and install:

make all

Build binary:

make build

Run Unit/Integ Tests:

make test

(see internal/README.md for explanation of tests)

Run tests against kind cluster and live controller:

make e2e

This will run the e2e suite against all examples.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Directories

Path Synopsis
Package apis contains Kubernetes API for the provider.
Package apis contains Kubernetes API for the provider.
aviatrix/v1alpha1
+kubebuilder:object:generate=true +groupName=aviatrix.aviatrix.upbound.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=aviatrix.aviatrix.upbound.io +versionName=v1alpha1
gateway/v1alpha1
+kubebuilder:object:generate=true +groupName=gateway.aviatrix.upbound.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=gateway.aviatrix.upbound.io +versionName=v1alpha1
segmentation/v1alpha1
+kubebuilder:object:generate=true +groupName=segmentation.aviatrix.upbound.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=segmentation.aviatrix.upbound.io +versionName=v1alpha1
spoke/v1alpha1
+kubebuilder:object:generate=true +groupName=spoke.aviatrix.upbound.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=spoke.aviatrix.upbound.io +versionName=v1alpha1
transit/v1alpha1
+kubebuilder:object:generate=true +groupName=transit.aviatrix.upbound.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=transit.aviatrix.upbound.io +versionName=v1alpha1
v1alpha1
Package v1alpha1 contains the core resources of the aviatrix jet provider.
Package v1alpha1 contains the core resources of the aviatrix jet provider.
v1beta1
Package v1beta1 contains the core resources of the aviatrix upjet provider.
Package v1beta1 contains the core resources of the aviatrix upjet provider.
cmd
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL