fiaas-go-client

module
v0.24.2 Latest Latest
Warning

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

Go to latest
Published: Jan 23, 2024 License: Apache-2.0

README

FIAAS Custom Resource Definition

This library contains a Custom Resource Definition and an auto-generated Go client used to manipulate the Application FIAAS resource.

Code responsible for generating this CRD is present in pkg/apis/fiaas.schibsted.io/v1/:

Everything in pkg/client and in pkg/apis/fiaas.schibsted.io/v1/zz_generated.deepcopy.go is completely auto generated. Please do not edit those files manually. Update any of the files listed above and run the code generation using make generate-code. Then, commit your changes and push.

make generate-code uses an update-codegen script adapted from the one Kubernetes maintainers use.

Type structure

In types.go, we made a deliberate choice to treat the Config struct field of the ApplicationSpec as a "black box" in the form of map[string]interface. The fiaas-deploy-daemon client will accept any config structure as long as it's valid YAML. This gives us the benefit of being backwards- and forwards compatible.

Usage

Tests

To run end-to-end tests, Kind and Docker must be installed. The end-to-end tests can be run with make e2e. To runs e2e tests against a specific Kubernetes version, set $K8S_VERSION, e.g. K8S_VERSION=vX.Y.Z make e2e.

Directories

Path Synopsis
pkg
apis/fiaas.schibsted.io/v1
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.
client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/clientset/versioned/typed/fiaas.schibsted.io/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/clientset/versioned/typed/fiaas.schibsted.io/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.

Jump to

Keyboard shortcuts

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