README
¶
PlatformWorkflow Operator
Description
Platform Workflow Operator enables publishing new Services in a cluster. Cluster Admins use this Operator to govern their cluster usage by defining and registering opinionated Services with appropriate guard rails. The new Services are registered as new Custom Resources. Application development teams consume the Services by creating instances of these Custom Resources.
Development steps
-
Setup:
Follow these steps
-
Modify:
- Making changes to Operator API (types.go)
- mkdir vendor/k8s.io/code-generator/hack
- cp hack/boilerplate.go.txt vendor/k8s.io/code-generator/hack/.
- ./hack/update-codegen.sh
-
Build: Update versions.txt before creating new versioned artifact.
./build-artifact.sh <latest | versioned>
Follow semver for tagging Docker images
Update artifacts/deployment/deployment.yaml
DO NOT create vendor directory running: go mod vendor
Vendoring seems to over-ride module versions defined in go.mod and brings in newer versions. This breaks the build. For building the code we need precisely those versions of the modules defined in go.mod.
The modules will be downloaded in following location: $GOPATH/mod/
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
client-gen
client-gen makes the individual typed clients using gengo.
|
client-gen makes the individual typed clients using gengo. |
|
client-gen/generators
Package generators has the generators for the client-gen utility.
|
Package generators has the generators for the client-gen utility. |
|
conversion-gen
conversion-gen is a tool for auto-generating Conversion functions.
|
conversion-gen is a tool for auto-generating Conversion functions. |
|
deepcopy-gen
deepcopy-gen is a tool for auto-generating DeepCopy functions.
|
deepcopy-gen is a tool for auto-generating DeepCopy functions. |
|
defaulter-gen
defaulter-gen is a tool for auto-generating Defaulter functions.
|
defaulter-gen is a tool for auto-generating Defaulter functions. |
|
go-to-protobuf
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct.
|
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct. |
|
go-to-protobuf/protobuf
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct.
|
go-to-protobuf generates a Protobuf IDL from a Go struct, respecting any existing IDL tags on the Go struct. |
|
go-to-protobuf/protoc-gen-gogo
Package main defines the protoc-gen-gogo binary we use to generate our proto go files, as well as takes dependencies on the correct gogo/protobuf packages for godeps.
|
Package main defines the protoc-gen-gogo binary we use to generate our proto go files, as well as takes dependencies on the correct gogo/protobuf packages for godeps. |
|
import-boss
import-boss enforces import restrictions in a given repository.
|
import-boss enforces import restrictions in a given repository. |
|
openapi-gen
This package generates openAPI definition file to be used in open API spec generation on API servers.
|
This package generates openAPI definition file to be used in open API spec generation on API servers. |
|
set-gen
set-gen is an example usage of gengo.
|
set-gen is an example usage of gengo. |
|
helm-pod
module
|
|
|
pkg
|
|
|
apis/workflowcontroller/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
|
generated/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
generated/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
generated/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
generated/clientset/versioned/typed/workflowcontroller/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
generated/clientset/versioned/typed/workflowcontroller/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |