README
¶
pkg/generated
Auto-generated clients consumed by the controller.
Overview
Everything under this directory is generated — never edit by hand. There are two unrelated halves:
| Subtree | Source | Generator |
|---|---|---|
clientset/ + informers/ + listers/ |
pkg/apis/haproxytemplate/v1alpha1/ (Go types) |
code-generator (make generate-clientset) |
dataplaneapi/v3{0,1,2,3}/ + dataplaneapi/v3{0,1,2}ee/ |
DataPlane API OpenAPI spec at each subtree's spec.json |
oapi-codegen (make generate-dataplaneapi-v3<x> / …ee) |
validators/ |
The same OpenAPI specs, used for zero-allocation request validation | make generate-validators |
All of the above run together via make generate. Run make verify-generate locally to verify that CRD manifests and DeepCopy methods are up-to-date (the dataplaneapi clients and validators are not checked by that target).
Refreshing the DataPlane API Clients
Bumping the OpenAPI spec for a HAProxy version is a two-step process:
./scripts/extract-dataplane-spec.sh 3.2 pkg/generated/dataplaneapi/v32/spec.json
make generate-dataplaneapi-v32
The Enterprise variants follow the same pattern but the extract script needs an --enterprise (or -e) flag and r1-suffixed versions because the spec lives in a different registry:
./scripts/extract-dataplane-spec.sh -e 3.2r1 pkg/generated/dataplaneapi/v32ee/spec.json
make generate-dataplaneapi-v32ee
./scripts/extract-dataplane-spec.sh --help-style usage is documented in the script's header — see the comment block at the top.
See Also
pkg/apis— the source Go types for the typed clientsetscripts/extract-dataplane-spec.sh— pulls a fresh OpenAPI spec from a running DataPlane APIMakefile— everygenerate-*target
License
Apache-2.0 — see root LICENSE.
Directories
¶
| Path | Synopsis |
|---|---|
|
clientset
|
|
|
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/haproxytemplate/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
versioned/typed/haproxytemplate/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
dataplaneapi
|
|
|
v30
Package v30 provides primitives to interact with the openapi HTTP API.
|
Package v30 provides primitives to interact with the openapi HTTP API. |
|
v30ee
Package v30ee provides primitives to interact with the openapi HTTP API.
|
Package v30ee provides primitives to interact with the openapi HTTP API. |
|
v31
Package v31 provides primitives to interact with the openapi HTTP API.
|
Package v31 provides primitives to interact with the openapi HTTP API. |
|
v31ee
Package v31ee provides primitives to interact with the openapi HTTP API.
|
Package v31ee provides primitives to interact with the openapi HTTP API. |
|
v32
Package v32 provides primitives to interact with the openapi HTTP API.
|
Package v32 provides primitives to interact with the openapi HTTP API. |
|
v32ee
Package v32ee provides primitives to interact with the openapi HTTP API.
|
Package v32ee provides primitives to interact with the openapi HTTP API. |
|
v33
Package v33 provides primitives to interact with the openapi HTTP API.
|
Package v33 provides primitives to interact with the openapi HTTP API. |
|
informers
|
|
|
listers
|
|
|
Package genvalidators holds the machine-generated zero-allocation OpenAPI validators and hashers for every supported HAProxy DataPlane API version.
|
Package genvalidators holds the machine-generated zero-allocation OpenAPI validators and hashers for every supported HAProxy DataPlane API version. |