README
¶
provider-styra
Crossplane provider for Styra DAS. The provider built from this repository can be installed into a Crossplane control plane or run seperately. It provides the following features:
- Extension of the K8s API with CRDs to represent Styra objects as K8s resources
- Controllers to provision these resources into a Styra instance
- Implementations of Crossplane's portable resource abstractions, enabling Styra resources to fulfill a user's general need for cloud services
Getting Started and Documentation
For getting start with Crossplane setup installation and deployment, see the official documentation.
To use provider-styra
- Setup a new Styra instance or use an existing one
- Create a new Styra API token, and store it in a K8s secret
kubectl create secret generic provider-styra-creds --from-literal=token=$API_TOKEN -n crossplane-system
- Create a new ProviderConfig resource with a references to this secret
You are now ready to create resources as described in examples.
Contributing
provider-styra is a community driven project and we welcome contributions. See the Crossplane Contributing guidelines to get started.
Adding New Resource
New resources can be added by defining the required types in apis and the controllers pkg/controllers/.
To generate the CRD YAML files run
make generate
Report a Bug
For filing bugs, suggesting improvements, or requesting new features, please open an issue.
Contact
Please use the following to reach members of the community:
- Slack: Join our slack channel
- Forums: crossplane-dev
- Twitter: @crossplane_io
- Email: info@crossplane.io
Governance and Owners
provider-styra is run according to the same Governance and Ownership structure as the core Crossplane project.
Code of Conduct
provider-styra adheres to the same Code of Conduct as the core Crossplane project.
Licensing
provider-styra is under the Apache 2.0 license.
Usage
To run the project
make run
To run all tests:
make test
To build the project
make build
To list all available options
make help
Code generation
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apis contains Kubernetes API for Cluster API.
|
Package apis contains Kubernetes API for Cluster API. |
|
datasource/v1alpha1
Package v1alpha1 contains the core resources of the styra provider.
|
Package v1alpha1 contains the core resources of the styra provider. |
|
secret/v1alpha1
Package v1alpha1 contains the core resources of the styra provider.
|
Package v1alpha1 contains the core resources of the styra provider. |
|
stack/v1alpha1
Package v1alpha1 contains the core resources of the styra provider.
|
Package v1alpha1 contains the core resources of the styra provider. |
|
system/v1alpha1
Package v1alpha1 contains the core resources of the styra provider.
|
Package v1alpha1 contains the core resources of the styra provider. |
|
v1alpha1
Package v1alpha1 contains core Styra resources.
|
Package v1alpha1 contains core Styra resources. |
|
cmd
|
|
|
pkg
|
|
|
client/mock/datasources
Package datasources is a generated GoMock package.
|
Package datasources is a generated GoMock package. |
|
client/mock/kube
Package kube is a generated GoMock package.
|
Package kube is a generated GoMock package. |
|
client/mock/policies
Package policies is a generated GoMock package.
|
Package policies is a generated GoMock package. |
|
client/mock/resource
Package resource is a generated GoMock package.
|
Package resource is a generated GoMock package. |
|
client/mock/secrets
Package secrets is a generated GoMock package.
|
Package secrets is a generated GoMock package. |
|
client/mock/stacks
Package stacks is a generated GoMock package.
|
Package stacks is a generated GoMock package. |
|
client/mock/systems
Package systems is a generated GoMock package.
|
Package systems is a generated GoMock package. |