provider-confluent

module
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Jun 14, 2024 License: Apache-2.0

README

Provider Confluent

provider-confluent is a Crossplane provider that is built using Upjet code generation tools and exposes XRM-conformant managed resources for the Confluent API.

Getting Started

Fix for make generate

The Confluent Provider Terraform documentation has a missing block that will cause the make generate command to fail with the following error:

scraper: error: Failed to scrape Terraform provider metadata: cannot scrape Terraform registry: failed to scrape resource metadata from path: ../.work/confluentinc/confluent/docs/resources/confluent_ksql_cluster.md: failed to find the prelude of the document using the xpath expressions: //text()[contains(., "description") and contains(., "page_title")]

To fix this, run:

broken_doc_file=".work/confluentinc/confluent/docs/resources/confluent_ksql_cluster.md"
echo '---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "confluent_ksql_cluster Resource - terraform-provider-confluent"
subcategory: ""
description: |-

---' | cat - $broken_doc_file > temp && mv temp $broken_doc_file

Install the provider by using the following command after changing the image tag to the latest release:

up ctp provider install crossplane-contrib/provider-confluent:v0.1.0

Alternatively, you can use declarative installation:

cat <<EOF | kubectl apply -f -
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
  name: provider-confluent
spec:
  package: crossplane-contrib/provider-confluent:v0.1.0
EOF

Notice that in this example Provider resource is referencing ControllerConfig with debug enabled.

You can see the API reference here.

Developing

Run code-generation pipeline:

go run cmd/generator/main.go "$PWD"

Run against a Kubernetes cluster:

make run

Build, push, and install:

make all

Build binary:

make build

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Credits

Initially developed by jaylevin, jtucci and their team at SAP.

Directories

Path Synopsis
Package apis contains Kubernetes API for the provider.
Package apis contains Kubernetes API for the provider.
confluent/v1alpha1
+kubebuilder:object:generate=true +groupName=confluent.crossplane.io +versionName=v1alpha1
+kubebuilder:object:generate=true +groupName=confluent.crossplane.io +versionName=v1alpha1
v1alpha1
Package v1alpha1 contains the core resources of the confluent jet provider.
Package v1alpha1 contains the core resources of the confluent jet provider.
v1beta1
Package v1beta1 contains the core resources of the confluent upjet provider.
Package v1beta1 contains the core resources of the confluent upjet provider.
cmd
internal

Jump to

Keyboard shortcuts

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