provider-rabbitmq

module
v0.0.0-...-0531ad1 Latest Latest
Warning

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

Go to latest
Published: Apr 3, 2025 License: Apache-2.0

README

provider-rabbitmq

provider-rabbitmq is a minimal Crossplane Provider that is meant to be used as a rabbitmq for implementing new Providers. It comes with the following features that are meant to be refactored:

  • A ProviderConfig type that only points to a credentials Secret.
  • A MyType resource type that serves as an example managed resource.
  • A managed resource controller that reconciles MyType objects and simply prints their configuration in its Observe method.

Developing

  1. Use this repository as a rabbitmq to create a new one.
  2. Run make submodules to initialize the "build" Make submodule we use for CI/CD.
  3. Rename the provider by running the following command:
  export provider_name=MyProvider # Camel case, e.g. GitHub
  make provider.prepare provider=${provider_name}
  1. Add your new type by running the following command:
  export group=sample # lower case e.g. core, cache, database, storage, etc.
  export type=MyType # Camel casee.g. Bucket, Database, CacheCluster, etc.
  make provider.addtype provider=${provider_name} group=${group} kind=${type}
  1. Replace the sample group with your new group in apis/{provider}.go
  2. Replace the mytype type with your new type in internal/controller/{provider}.go
  3. Replace the default controller and ProviderConfig implementations with your own
  4. Run make reviewable to run code generation, linters, and tests.
  5. Run make build to build the provider.

Refer to Crossplane's CONTRIBUTING.md file for more information on how the Crossplane community prefers to work. The Provider Development guide may also be of use.

make provider.prepare provider=RabbitMq
make provider.addtype provider=RabbitMq group=core kind=Vhost
make generate

Directories

Path Synopsis
Package apis contains Kubernetes API for the RabbitMq provider.
Package apis contains Kubernetes API for the RabbitMq provider.
core
Package core contains group core API versions
Package core contains group core API versions
core/v1alpha1
Package v1alpha1 contains the v1alpha1 group Sample resources of the RabbitMq provider.
Package v1alpha1 contains the v1alpha1 group Sample resources of the RabbitMq provider.
v1alpha1
Package v1alpha1 contains the core resources of the RabbitMq provider.
Package v1alpha1 contains the core resources of the RabbitMq provider.
cmd
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
JackTT - Gopher 🇻🇳