diff --git a/README.md b/README.md index 54709ba..7cb79a8 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,114 @@ + + # Confluent for Kubernetes Playground + + + + +[![README Header][readme_header_img]][readme_header_link] + + This repository contains Scenario workflows to deploy and manage Confluent on Kubernetes for various use cases. -## Overview +This GitHub repository accompanies the official [Confluent for Kubernetes documentation](https://docs.confluent.io/operator/current/overview.html). + +--- + + + + + + +## Usage + +### Overview The examples found in this repository have been tested against a local minikube. -## Prerequisites +### Prerequisites You will need a Kubernetes cluster version 1.16 or newer and kubectl version 1.18 running locally. -* kubectl -* [Minikube](https://minikube.sigs.k8s.io/docs/start/) + * kubectl + * [Minikube](https://minikube.sigs.k8s.io/docs/start/) -## Deploying an example -Before you can deploy any of the deployment examples found in `./examples`, we must first deploy the Confluent-specific CRDs. To deploy, from the root of this repository, run: + + +## Examples + +Before you can deploy any of the deployment examples found in `./examples`, we must first deploy the Confluent-specific CRDs. To deploy, from the root of this repository, run: +```shell + $ kubectl apply --kustomize ./kustomize/crds ``` -$ kubectl apply --kustomize ./kustomize/crds -``` -### Examples -## TODO \ No newline at end of file +### CFK Deployments + * [Vault PKI integration with dynamic SSL](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/basic-pki-vault) + * [Basic CFK install with auto generated certificates](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/basic) + * [Kafka Connect GCP Spanner in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/custom-connect-gcp-connectors) + * [Kafka Connect SQL Server in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/custom-connect-sql) + * [Monitoring Kakfa CFK with JMX Prometheus and Grafana](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/elk-logging) + * [RBAC enabled CFK cluster wth OpenLDAP](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/rbac) + * [Cloud to Cloud replication using Confluent replicator in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/replicator) + * [User provided mTLS for Kafka in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/userprovided-mtls) + * [Vault enabled secrets store for Kafka](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/vault-key-value) + + + + + +## Related Projects + +Check out these related projects. + +- [Kafka GitOps Example](https://github.com/osodevops/kafka-gitops-examples) - A Kafka / Confluent GitOps workflow example for multi-env deployments with Flux, Kustomize, Helm and Confluent Operator +- [Confluent Platform on Azure](https://github.com/osodevops/terraform-azure-confluent-platform) - Terraform Module for deploying best practice HA Confluent Platform on Azure +- [Run Confluent Platform locally with Vagrant](https://github.com/osodevops/vagrant-confluent-platform) - Vagrantfile to start a virtual machine running the confluent platform: Zookeeper, Kafka, Schema registry and Confluent control centre using cp-ansible + + + +## Need some help + +File a GitHub [issue](https://github.com/osodevops/confluent-kubernetes-playground/issues), send us an [email][email] or [tweet us][twitter]. + +## The legals + +Copyright © 2017-2021 [OSO](https://oso.sh) | See [LICENCE](LICENSE) for full details. + +[OSO who we are](https://oso.sh/who-we-are/) + +## Who we are + +We at [OSO][website] help teams to adopt emerging technologies and solutions to boost their competitiveness, operational excellence and introduce meaningful innovations that drive real business growth. Our developer-first culture, combined with our cross-industry experience and battle-tested delivery methods allow us to implement the most impactful solutions for your business. + +Looking for support applying emerging technologies in your business? We’d love to hear from you, get in touch by [email][email] + +Start adopting new technologies by checking out [our other projects][github], [follow us on twitter][twitter], [join our team of leaders and challengers][careers], or [contact us][contact] to find the right technology to support your business.[![Beacon][beacon]][website] + + [logo]: https://oso-public-resources.s3.eu-west-1.amazonaws.com/oso-logo-green.png + [website]: https://oso.sh?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=website + [github]: https://github.com/osodevops?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=github + [careers]: https://oso.sh/careers/?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=careers + [contact]: https://oso.sh/contact/?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=contact + [linkedin]: https://www.linkedin.com/company/oso-devops?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=linkedin + [twitter]: https://twitter.com/osodevops?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=twitter + [email]: mailto:enquiries@oso.sh?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=email + [readme_header_img]: https://oso-public-resources.s3.eu-west-1.amazonaws.com/oso-animation.gif + [readme_header_link]: https://oso.sh/what-we-do/?utm_source=github&utm_medium=readme&utm_campaign=osodevops/confluent-kubernetes-playground&utm_content=readme_header_link + [beacon]: https://github-analyics.ew.r.appspot.com/G-WV0Q3HYW08/osodevops/confluent-kubernetes-playground?pixel&cs=github&cm=readme&an=confluent-kubernetes-playground diff --git a/README.yaml b/README.yaml new file mode 100755 index 0000000..3ad734b --- /dev/null +++ b/README.yaml @@ -0,0 +1,56 @@ +--- +# +# This is the canonical configuration for the `README.md` +# Run `make readme` to rebuild the `README.md` +# + +# Name of this project +name: "Confluent for Kubernetes Playground" + +# Short description of this project +description: |- + This repository contains Scenario workflows to deploy and manage Confluent on Kubernetes for various use cases. + + This GitHub repository accompanies the official [Confluent for Kubernetes documentation](https://docs.confluent.io/operator/current/overview.html). + +# Canonical GitHub repo +github_repo: osodevops/confluent-kubernetes-playground + +# How to use this project +usage: |- + ### Overview + The examples found in this repository have been tested against a local minikube. + + ### Prerequisites + You will need a Kubernetes cluster version 1.16 or newer and kubectl version 1.18 running locally. + * kubectl + * [Minikube](https://minikube.sigs.k8s.io/docs/start/) + +# Example usage +examples: |- + Before you can deploy any of the deployment examples found in `./examples`, we must first deploy the Confluent-specific CRDs. To deploy, from the root of this repository, run: + ```shell + $ kubectl apply --kustomize ./kustomize/crds + ``` + + ### CFK Deployments + * [Vault PKI integration with dynamic SSL](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/basic-pki-vault) + * [Basic CFK install with auto generated certificates](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/basic) + * [Kafka Connect GCP Spanner in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/custom-connect-gcp-connectors) + * [Kafka Connect SQL Server in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/custom-connect-sql) + * [Monitoring Kakfa CFK with JMX Prometheus and Grafana](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/elk-logging) + * [RBAC enabled CFK cluster wth OpenLDAP](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/rbac) + * [Cloud to Cloud replication using Confluent replicator in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/replicator) + * [User provided mTLS for Kafka in CFK](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/userprovided-mtls) + * [Vault enabled secrets store for Kafka](https://github.com/osodevops/confluent-kubernetes-playground/tree/main/examples/vault-key-value) + +related: + - name: "Kafka GitOps Example" + description: "A Kafka / Confluent GitOps workflow example for multi-env deployments with Flux, Kustomize, Helm and Confluent Operator" + url: "https://github.com/osodevops/kafka-gitops-examples" + - name: "Confluent Platform on Azure" + description: "Terraform Module for deploying best practice HA Confluent Platform on Azure" + url: "https://github.com/osodevops/terraform-azure-confluent-platform" + - name: "Run Confluent Platform locally with Vagrant" + description: "Vagrantfile to start a virtual machine running the confluent platform: Zookeeper, Kafka, Schema registry and Confluent control centre using cp-ansible" + url: "https://github.com/osodevops/vagrant-confluent-platform" diff --git a/docs/targets.md b/docs/targets.md new file mode 100644 index 0000000..fcc742c --- /dev/null +++ b/docs/targets.md @@ -0,0 +1,8 @@ + +## Makefile Targets +```text +Available targets: + + +``` +