api

module
v0.0.0-...-dfc9681 Latest Latest
Warning

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

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

README

Maistra API and Go client

This repository contains Go API, Kubernetes CRD's and a Go client for dealing with Maistra objects.

Documentation

Refer to the API documentation to learn more about the role of each resource.

Tree hierarchy

API

The API itself is contained in these directories, with a version (e.g. v1 or v2) as subdirs.

  • core/v1: Contains the following types:
    • ServiceMeshControlPlane
    • ServiceMeshExtension
    • ServiceMeshMember
    • ServiceMeshMemberRoll.
  • core/v1alpha1: Contains the following types:
    • ServiceMeshExtension
    • ServiceExports
    • MeshFederation.
  • core/v2: Contains the following types:
    • ServiceMeshControlPlane.
CRDs
  • manifests: Holds the CRD yaml files for Maistra types.
Go client
  • client/versioned: Clientset
  • client/listers: Listers
  • client/informers: informers
Examples
  • example: Full example of how to use the Go client and the API.
Vendor
  • Vendored dependencies

Development

Most of the files are autogenerated. After making changes to the relevant files, just run make (or make clean gen) and commit all the result.

Directories

Path Synopsis
client
versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
versioned/typed/core/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
versioned/typed/core/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
versioned/typed/core/v1alpha1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
versioned/typed/core/v1alpha1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
versioned/typed/core/v2
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
versioned/typed/core/v2/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
versioned/typed/federation/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
versioned/typed/federation/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.
core
v1
Package v1 contains API Schema definitions for the maistra.io v1 API group +kubebuilder:object:generate=true +groupName=maistra.io
Package v1 contains API Schema definitions for the maistra.io v1 API group +kubebuilder:object:generate=true +groupName=maistra.io
v1alpha1
+k8s:conversion-gen=maistra.io/api/core/v1alpha1 +k8s:conversion-gen-external-types=maistra.io/api/core/v1
+k8s:conversion-gen=maistra.io/api/core/v1alpha1 +k8s:conversion-gen-external-types=maistra.io/api/core/v1
v2
Package v2 contains API Schema definitions for the maistra.io v2 API group +kubebuilder:object:generate=true +groupName=maistra.io
Package v2 contains API Schema definitions for the maistra.io v2 API group +kubebuilder:object:generate=true +groupName=maistra.io
federation
v1
+groupName=federation.maistra.io
+groupName=federation.maistra.io
DO NOT DELETE THIS FILE
DO NOT DELETE THIS FILE
security
v1
Code generated by protoc-gen-deepcopy.
Code generated by protoc-gen-deepcopy.
tools

Jump to

Keyboard shortcuts

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