diff --git a/.github/workflows/ci-docs.yaml b/.github/workflows/ci-docs.yaml index e57e36455..5141685f2 100644 --- a/.github/workflows/ci-docs.yaml +++ b/.github/workflows/ci-docs.yaml @@ -23,13 +23,13 @@ jobs: - name: Set up Hugo uses: peaceiris/actions-hugo@6e295a6a0c9087bf374299e9d67f9d2edab9f18f # v3.0.0 with: - hugo-version: '0.110.0' + hugo-version: 'latest' extended: true - name: Set up Node uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0 with: - node-version: 16 + node-version: 20 - name: Set up PostCSS run: npm install --save-dev autoprefixer postcss-cli postcss diff --git a/.github/workflows/publish-docs.yaml b/.github/workflows/publish-docs.yaml index b851a0cb1..19f525846 100644 --- a/.github/workflows/publish-docs.yaml +++ b/.github/workflows/publish-docs.yaml @@ -26,13 +26,13 @@ jobs: - name: Set up Hugo uses: peaceiris/actions-hugo@6e295a6a0c9087bf374299e9d67f9d2edab9f18f # v3.0.0 with: - hugo-version: '0.110.0' + hugo-version: 'latest' extended: true - name: Set up Node uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0 with: - node-version: 16 + node-version: 20 - name: Set up PostCSS run: npm install --save-dev autoprefixer postcss-cli postcss diff --git a/config/_default/config.toml b/config/_default/config.toml index d6cea4b5a..54f64768e 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -77,9 +77,9 @@ weight = 1 url_latest_version = "/" # Repository configuration (URLs for in-page links to opening issues and suggesting changes) - github_repo = "https://github.com/banzaicloud/koperator-docs" + github_repo = "https://github.com/adobe/koperator/tree/gh-pages" # An optional link to a related project repo. For example, the sibling repository where your product code lives. - github_project_repo = "https://github.com/banzaicloud/koperator" + github_project_repo = "https://github.com/adobe/koperator" # Specify a value here if your content directory is not in your repo's root directory # github_subdir = "" @@ -114,7 +114,7 @@ weight = 1 # Set to true to disable breadcrumb navigation. breadcrumb_disable = false # Set to true to disable the About link in the site footer - footer_about_disable = false + footer_about_enable = true # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar navbar_logo = true # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. @@ -130,39 +130,12 @@ weight = 1 enable = true [params.links] - # End user relevant links. These will show up on left side of footer and in the community page if you have one. - #[[params.links.user]] - # name = "Community forum" - # url = "https://community.cisco.com/t5/application-networking-and/bd-p/dev-app-networking" - # icon = "fa fa-envelope" - # desc = "Discussion and help from your fellow users" - #[[params.links.user]] - # name ="Twitter" - # url = "https://twitter.com/ciscoemerge" - # icon = "fab fa-twitter" - # desc = "Follow us on Twitter to get the latest news!" - #[[params.links.user]] - # name = "Linkedin" - # url = "https://linkedin.com/cisco-emerging-technologies-and-incubation" - # icon = "fab fa-linkedin" - # desc = "Follow us on Twitter to get the latest news!" - # Developer relevant links. These will show up on right side of footer and in the community page if you have one. [[params.links.developer]] name = "GitHub" - url = "https://github.com/banzaicloud/koperator" + url = "https://github.com/adobe/koperator" icon = "fab fa-github" desc = "Get involved with Koperator development" - [[params.links.developer]] - name = "Slack" - url = "https://outshift.slack.com" - icon = "fab fa-slack" - desc = "Chat with the project developers" - #[[params.links.developer]] - # name = "Developer mailing list" - # url = "https://example.org/mail" - # icon = "fa fa-envelope" - # desc = "Discuss development issues around the project" - + ############################################################################### # Hugo - Top-level navigation (horizontal) ############################################################################### @@ -171,22 +144,13 @@ weight = 1 name = "Project page" weight = -110 pre = "" - url = "https://github.com/banzaicloud/koperator" -# [[menu.main]] -# name = "Blog" -# weight = -120 -# pre = "" -# url = "https://github.com/bank-vaults/" + url = "https://github.com/adobe/koperator" [[menu.main]] name = "Documentation" weight = -100 pre = "" url = "/docs/" - [[menu.main]] - name = "Community" - url = "https://outshift.slack.com" - pre = "" - weight = 150 + ############################################################################### # Misc customizations @@ -218,13 +182,9 @@ anchor = "smart" [security.funcs] getenv = ['^HUGO_', 'PWD', '^DOC_', 'ENVIRONMENT'] -[privacy] - [privacy.googleAnalytics] - respectDoNotTrack = true - [module] proxy = "direct" [[module.imports]] path = "github.com/google/docsy" [[module.imports]] -path = "github.com/google/docsy/dependencies" \ No newline at end of file +path = "github.com/google/docsy/dependencies" diff --git a/config/production/config.toml b/config/production/config.toml index 679d65a72..f67535665 100644 --- a/config/production/config.toml +++ b/config/production/config.toml @@ -1,12 +1,7 @@ -baseurl = "https://banzaicloud.github.io/koperator-docs/" +baseurl = "https://opensource.adobe.com/koperator/" buildDrafts = false -#googleAnalytics = "G-FIXME" +googleAnalytics = "G-FIXME" -[services] -[services.googleAnalytics] -# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. -#id = "G-FIXME" [params] - -url_latest_version = "https://banzaicloud.github.io/koperator-docs/" \ No newline at end of file +url_latest_version = "https://opensource.adobe.com/koperator/" \ No newline at end of file diff --git a/content/_index.md b/content/_index.md index 41b0779b7..21def7e77 100644 --- a/content/_index.md +++ b/content/_index.md @@ -19,11 +19,9 @@ title: Koperator Read the Koperator documentation. {{% /blocks/feature %}} -{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/banzaicloud/koperator" %}} -We do a [Pull Request](https://github.com/banzaicloud/koperator/pulls) contributions workflow on **GitHub**. New users and developers are always welcome! +{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/adobe/koperator" %}} +We do a [Pull Request](https://github.com/adobe/koperator/pulls) contributions workflow on **GitHub**. New users and developers are always welcome! {{% /blocks/feature %}} -{{% blocks/feature icon="fa-brands fa-slack" title="Come chat with us!" url="https://outshift.slack.com/messages/koperator" url_text="Join Slack" %}} -In case you need help, you can find us on Slack. -{{% /blocks/feature %}} -{{< /blocks/section >}} \ No newline at end of file +{{< /blocks/section >}} + diff --git a/content/docs/benchmarks/_index.md b/content/docs/benchmarks/_index.md index c724b718f..d4f23fd1a 100644 --- a/content/docs/benchmarks/_index.md +++ b/content/docs/benchmarks/_index.md @@ -72,7 +72,7 @@ How to setup the environment for the Kafka Performance Test. 1. Install the Koperator CustomResourceDefinition resources (adjust the version number to the Koperator release you want to install) and the corresponding version of Koperator, the Operator for managing Apache Kafka on Kubernetes. ```bash - kubectl create --validate=false -f https://github.com/banzaicloud/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml + kubectl create --validate=false -f https://github.com/adobe/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml ``` ```bash diff --git a/content/docs/compatibility-matrix.md b/content/docs/compatibility-matrix.md index ec898f2f3..72b016877 100644 --- a/content/docs/compatibility-matrix.md +++ b/content/docs/compatibility-matrix.md @@ -10,16 +10,16 @@ This page shows you the list of supported Koperator versions, and the versions o |Operator Version|Apache Kafka Version|JMX Exporter Version|Cruise Control Version|Istio Operator Version|Example cluster CR|Maintained| |-------|------|----------------|-------|----|---|-| -|v0.18.3|2.6.2+|0.15.0|2.5.37|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.18.3/config/samples/simplekafkacluster.yaml)|-| -|v0.19.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.19.0/config/samples/simplekafkacluster.yaml)|-| -|v0.20.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.20.0/config/samples/simplekafkacluster.yaml)|-| -|v0.20.2|2.6.2+|0.16.1|2.5.80|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.20.2/config/samples/simplekafkacluster.yaml)|-| -|v0.21.0|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/banzaicloud/koperator/blob/v0.21.0/config/samples/simplekafkacluster.yaml)|-| -|v0.21.1|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/banzaicloud/koperator/blob/v0.21.1/config/samples/simplekafkacluster.yaml)|-| -|v0.21.2|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/banzaicloud/koperator/blob/v0.21.2/config/samples/simplekafkacluster.yaml)|-| -|v0.22.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/banzaicloud/koperator/blob/v0.22.0/config/samples/simplekafkacluster.yaml)|+| -|v0.23.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/banzaicloud/koperator/blob/v0.23.0/config/samples/simplekafkacluster.yaml)|+| -|v0.24.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/banzaicloud/koperator/blob/v0.24.0/config/samples/simplekafkacluster.yaml)|+| +|v0.18.3|2.6.2+|0.15.0|2.5.37|1.10|[link](https://github.com/adobe/koperator/blob/v0.18.3/config/samples/simplekafkacluster.yaml)|-| +|v0.19.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/adobe/koperator/blob/v0.19.0/config/samples/simplekafkacluster.yaml)|-| +|v0.20.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/adobe/koperator/blob/v0.20.0/config/samples/simplekafkacluster.yaml)|-| +|v0.20.2|2.6.2+|0.16.1|2.5.80|1.10|[link](https://github.com/adobe/koperator/blob/v0.20.2/config/samples/simplekafkacluster.yaml)|-| +|v0.21.0|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.0/config/samples/simplekafkacluster.yaml)|-| +|v0.21.1|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.1/config/samples/simplekafkacluster.yaml)|-| +|v0.21.2|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.2/config/samples/simplekafkacluster.yaml)|-| +|v0.22.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.22.0/config/samples/simplekafkacluster.yaml)|+| +|v0.23.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.23.0/config/samples/simplekafkacluster.yaml)|+| +|v0.24.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.24.0/config/samples/simplekafkacluster.yaml)|+| ## Available Koperator images diff --git a/content/docs/configurations/crd/_index.md b/content/docs/configurations/crd/_index.md index 55d2252b2..b9da73ea6 100644 --- a/content/docs/configurations/crd/_index.md +++ b/content/docs/configurations/crd/_index.md @@ -5,4 +5,4 @@ weight: 990 The following sections contain the reference documentation of the various custom resource definitions (CRDs) that are specific to Koperator. -For sample YAML files, see the [samples directory in the GitHub project](https://github.com/banzaicloud/koperator/tree/master/config/samples). +For sample YAML files, see the [samples directory in the GitHub project](https://github.com/adobe/koperator/tree/master/config/samples). diff --git a/content/docs/configurations/examples/_index.md b/content/docs/configurations/examples/_index.md index 9bde014db..9184dc056 100644 --- a/content/docs/configurations/examples/_index.md +++ b/content/docs/configurations/examples/_index.md @@ -11,52 +11,52 @@ You can use these examples as a base for your own Kafka cluster. This is our most descriptive KafkaCluster CR. You can find a lot of valuable explanation about the settings. -- [Detailed CR with descriptions](https://github.com/banzaicloud/koperator/blob/master/config/samples/banzaicloud_v1beta1_kafkacluster.yaml) +- [Detailed CR with descriptions](https://github.com/adobe/koperator/blob/master/config/samples/banzaicloud_v1beta1_kafkacluster.yaml) ## Kafka cluster with monitoring This is a very simple KafkaCluster CR with Prometheus monitoring enabled. -- [Simple KafkaCluster with monitoring](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster.yaml) +- [Simple KafkaCluster with monitoring](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster.yaml) ## Kafka cluster with ACL, SSL, and rack awareness You can read more details about rack awareness [here]({{< relref "../../rackawareness/index.md" >}}). -- [Use SSL and rack awareness](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups.yaml) +- [Use SSL and rack awareness](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups.yaml) ## Kafka cluster with broker configuration -- [Use broker configuration groups](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_without_ssl_groups.yaml) -- [Use independent broker configurations](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_without_ssl.yaml) +- [Use broker configuration groups](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_without_ssl_groups.yaml) +- [Use independent broker configurations](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_without_ssl.yaml) ## Kafka cluster with custom SSL certificates for external listeners You can specify custom SSL certificates for listeners. For details about SSL configuration, see {{% xref "../../ssl.md" %}}. -- [Use custom SSL certificate for an external listener](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_external_ssl_customcert.yaml) -- [Use custom SSL certificate for controller and inter-broker communication](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups_customcert.yaml). In this case you also need to provide the client SSL certificate for Koperator. -- [Hybrid solution](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_hybrid_customcert.yaml): some listeners have custom SSL certificates and some use certificates Koperator has generated automatically using cert-manager. +- [Use custom SSL certificate for an external listener](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_external_ssl_customcert.yaml) +- [Use custom SSL certificate for controller and inter-broker communication](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups_customcert.yaml). In this case you also need to provide the client SSL certificate for Koperator. +- [Hybrid solution](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_hybrid_customcert.yaml): some listeners have custom SSL certificates and some use certificates Koperator has generated automatically using cert-manager. ## Kafka cluster with SASL You can use SASL authentication on the listeners. For details, see {{% xref "../../external-listener/index.md" %}}. -- [Use SASL authentication on the listeners](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster_with_sasl.yaml) +- [Use SASL authentication on the listeners](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_with_sasl.yaml) ## Kafka cluster with load balancers and brokers in the same availability zone You can create a broker-ingress mapping to eliminate traffic across availability zones between load balancers and brokers by configuring load balancers for brokers in same availability zone. -- [Load balancers and brokers in same availability zone](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster-with-brokerbindings.yaml) +- [Load balancers and brokers in same availability zone](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster-with-brokerbindings.yaml) ## Kafka cluster with Istio You can use Istio as the ingress controller for your external listeners. It requires using our [Istio operator](https://github.com/banzaicloud/istio-operator) in the Kubernetes cluster. -- [Kafka cluster with Istio as ingress controller](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster-with-istio.yaml) +- [Kafka cluster with Istio as ingress controller](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster-with-istio.yaml) ## Kafka cluster with custom advertised address for external listeners and brokers @@ -65,16 +65,16 @@ This is useful when you're advertising the brokers on an IP address different fr You can also set custom advertised address for external listeners. For details, see {{% xref "../../external-listener/index.md" %}}. -- [Custom advertised address for external listeners](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster-with-nodeport-external.yaml) +- [Custom advertised address for external listeners](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster-with-nodeport-external.yaml) ## Kafka cluster with Kubernetes scheduler affinity settings You can set node [affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) for your brokers. -- [Custom affinity settings](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster_affinity.yaml) +- [Custom affinity settings](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_affinity.yaml) ## Kafka cluster with custom storage class You can configure your brokers to use custom [storage classes](https://kubernetes.io/docs/concepts/storage/storage-classes/). -- [Custom storage class](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster_ebs_csi.yaml) +- [Custom storage class](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_ebs_csi.yaml) diff --git a/content/docs/cruisecontroloperation.md b/content/docs/cruisecontroloperation.md index b3110b6e6..582e1df38 100644 --- a/content/docs/cruisecontroloperation.md +++ b/content/docs/cruisecontroloperation.md @@ -163,7 +163,7 @@ status: - The `state` shows the progress of the request. - The `summary` is Cruise Control's optimization proposal. It shows the scope of the changes that Cruise Control will apply through the operation. - The `retryCount` field shows the number of retries when a task has failed and `cruiseControlOperation.spec.errorPolicy` is set to `retry`. In this case, the `status.failedTask` field shows the history of the failed tasks (including their error messages). -For further information on the fields, see the [source code](https://github.com/banzaicloud/koperator/blob/master/api/v1alpha1/cruisecontroloperation_types.go). +For further information on the fields, see the [source code](https://github.com/adobe/koperator/blob/master/api/v1alpha1/cruisecontroloperation_types.go). ## Control the created CruiseControlOperation {#control-cruisecontroloperation} diff --git a/content/docs/delete-kafka-operator.md b/content/docs/delete-kafka-operator.md index 18d787844..508ca3dda 100644 --- a/content/docs/delete-kafka-operator.md +++ b/content/docs/delete-kafka-operator.md @@ -75,7 +75,7 @@ In case you want to delete the Koperator from your cluster, note that because of 1. Delete Koperator Custom Resource Definitions (CRDs). ``` - kubectl delete -f https://github.com/banzaicloud/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml + kubectl delete -f https://github.com/adobe/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml ``` ## Uninstall Prometheus operator diff --git a/content/docs/developer.md b/content/docs/developer.md index 2511f74fb..8c69f3767 100644 --- a/content/docs/developer.md +++ b/content/docs/developer.md @@ -11,7 +11,7 @@ If you find this project useful here's how you can help: - Send a pull request with your new features and bug fixes - Help new users with issues they may encounter -- Support the development of this project and [star this repo](https://github.com/banzaicloud/koperator/)! +- Support the development of this project and [star this repo](https://github.com/adobe/koperator/)! When you are opening a PR to Koperator the first time we will require you to sign a standard CLA. diff --git a/content/docs/external-listener/index.md b/content/docs/external-listener/index.md index 40b66a321..d46bf659c 100644 --- a/content/docs/external-listener/index.md +++ b/content/docs/external-listener/index.md @@ -84,7 +84,7 @@ To configure an external listener that uses the LoadBalancer access method, comp Configure the ingress controller you want to use: - - To use Envoy, set the `ingressController` field in the `KafkaCluster` custom resource to `envoy`. For an example, [see](https://github.com/banzaicloud/koperator/blob/672b19d49e5c0a22f9658181003beddb56f17d33/config/samples/banzaicloud_v1beta1_kafkacluster.yaml#L12). + - To use Envoy, set the `ingressController` field in the `KafkaCluster` custom resource to `envoy`. For an example, [see](https://github.com/adobe/koperator/blob/672b19d49e5c0a22f9658181003beddb56f17d33/config/samples/banzaicloud_v1beta1_kafkacluster.yaml#L12). For OpenShift: @@ -107,7 +107,7 @@ To configure an external listener that uses the LoadBalancer access method, comp ingressController: "envoy" ``` - - To use Istio ingress controller set the `ingressController` field to `istioingress`. [Istio operator](https://github.com/banzaicloud/istio-operator) v2 is supported from Koperator version 0.21.0+. Istio operator v2 supports multiple Istio control plane on the same cluster, that is why the corresponding control plane to the gateway must be specified. The `istioControlPlane` field in the `KafkaCluster` custom resource is a reference to that IstioControlPlane resource. For an example, [see](https://github.com/banzaicloud/koperator/blob/672b19d49e5c0a22f9658181003beddb56f17d33/config/samples/kafkacluster-with-istio.yaml#L10). + - To use Istio ingress controller set the `ingressController` field to `istioingress`. [Istio operator](https://github.com/banzaicloud/istio-operator) v2 is supported from Koperator version 0.21.0+. Istio operator v2 supports multiple Istio control plane on the same cluster, that is why the corresponding control plane to the gateway must be specified. The `istioControlPlane` field in the `KafkaCluster` custom resource is a reference to that IstioControlPlane resource. For an example, [see](https://github.com/adobe/koperator/blob/672b19d49e5c0a22f9658181003beddb56f17d33/config/samples/kafkacluster-with-istio.yaml#L10). ```yaml spec: diff --git a/content/docs/install-kafka-operator.md b/content/docs/install-kafka-operator.md index 5447f0354..1eeaba9dc 100644 --- a/content/docs/install-kafka-operator.md +++ b/content/docs/install-kafka-operator.md @@ -484,14 +484,14 @@ Koperator uses [Prometheus](https://prometheus.io/) for exporting metrics of the ### Install Koperator with Helm {#install-kafka-operator-with-helm} -Koperator can be deployed using its [Helm chart](https://github.com/banzaicloud/koperator/tree/{{< param "latest_version" >}}/charts). +Koperator can be deployed using its [Helm chart](https://github.com/adobe/koperator/tree/{{< param "latest_version" >}}/charts). 1. Install the Koperator CustomResourceDefinition resources (adjust the version number to the Koperator release you want to install). This is performed in a separate step to allow you to uninstall and reinstall Koperator without deleting your installed custom resources. ```bash kubectl create \ --validate=false \ - -f https://github.com/banzaicloud/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml + -f https://github.com/adobe/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml ``` Expected output: @@ -554,7 +554,7 @@ Koperator can be deployed using its [Helm chart](https://github.com/banzaicloud/ ```bash install.go:194: [debug] Original chart version: "" - install.go:211: [debug] CHART PATH: /Users/pregnor/development/src/github.com/banzaicloud/koperator/kafka-operator-{{< param "latest_version" >}}.tgz + install.go:211: [debug] CHART PATH: /Users/pregnor/development/src/github.com/adobe/koperator/kafka-operator-{{< param "latest_version" >}}.tgz # ... NAME: kafka-operator @@ -582,7 +582,7 @@ Koperator can be deployed using its [Helm chart](https://github.com/banzaicloud/ ### Deploy a Kafka cluster {#deploy-a-kafka-cluster} -1. Create the Kafka cluster using the KafkaCluster custom resource. You can find various examples for the custom resource in {{% xref "/docs/configurations/_index.md" %}} and in the [Koperator repository](https://github.com/banzaicloud/koperator/tree/{{< param "latest_version" >}}/config/samples). +1. Create the Kafka cluster using the KafkaCluster custom resource. You can find various examples for the custom resource in {{% xref "/docs/configurations/_index.md" %}} and in the [Koperator repository](https://github.com/adobe/koperator/tree/{{< param "latest_version" >}}/config/samples). {{< include-headless "warning-listener-protocol.md" >}} diff --git a/content/docs/monitoring.md b/content/docs/monitoring.md index a674bf796..3055ce79b 100644 --- a/content/docs/monitoring.md +++ b/content/docs/monitoring.md @@ -58,7 +58,7 @@ Prometheus must be configured to recognize these annotations. The following exam target_label: __address__ ``` -If you are using the provided [CR](https://github.com/banzaicloud/koperator/blob/master/config/samples/banzaicloud_v1beta1_kafkacluster.yaml), the operator installs the official [jmx exporter](https://github.com/prometheus/jmx_exporter) for Prometheus. +If you are using the provided [CR](https://github.com/adobe/koperator/blob/master/config/samples/banzaicloud_v1beta1_kafkacluster.yaml), the operator installs the official [jmx exporter](https://github.com/prometheus/jmx_exporter) for Prometheus. To change this behavior, modify the following lines at the end of the CR. diff --git a/content/docs/rackawareness/index.md b/content/docs/rackawareness/index.md index b3f94a0d5..7e5722432 100644 --- a/content/docs/rackawareness/index.md +++ b/content/docs/rackawareness/index.md @@ -8,7 +8,7 @@ Kafka automatically replicates partitions across brokers, so if a broker fails, > Note: All brokers deployed by Koperator must belong to the same Kubernetes cluster. -Since rack awareness is so vitally important, especially in multi-region and hybrid-cloud environments, the [Koperator](https://github.com/banzaicloud/koperator) provides an automated solution for it, and allows fine-grained broker rack configuration based on pod affinities and anti-affinities. +Since rack awareness is so vitally important, especially in multi-region and hybrid-cloud environments, the [Koperator](https://github.com/adobe/koperator) provides an automated solution for it, and allows fine-grained broker rack configuration based on pod affinities and anti-affinities. When [well-known Kubernetes labels](https://kubernetes.io/docs/reference/kubernetes-api/labels-annotations-taints/) are available (for example, AZ, node labels, and so on), the Koperator attempts to improve broker resilience by default. @@ -43,7 +43,7 @@ Note that depending on your use case, you might need additional configuration on ## Under the hood -As mentioned earlier, `broker.rack` is a read-only broker config, so is set whenever the broker starts or restarts. The [Koperator](https://github.com/banzaicloud/koperator) holds all its configs within a ConfigMap in each broker. +As mentioned earlier, `broker.rack` is a read-only broker config, so is set whenever the broker starts or restarts. The [Koperator](https://github.com/adobe/koperator) holds all its configs within a ConfigMap in each broker. Getting label values from nodes and using them to generate a ConfigMap is relatively easy, but to determine where the exact broker/pod is scheduled, the operator has to wait until the pod is *actually* scheduled to a node. Luckily, Kubernetes schedules pods even when a given ConfigMap is unavailable. However, the corresponding pod will remain in a pending state as long as the ConfigMap is not available to mount. The operator makes use of this pending state to gather all the necessary node labels and initialize a ConfigMap with the fetched data. To take advantage of this, we introduced a status field called `RackAwarenessState` in our CRD. The operator populates this status field with two values, `WaitingForRackAwareness` and `Configured`. ![Rack Awareness](/img/blog/kafka-rack-awareness/kafkarack.gif) diff --git a/content/docs/scenarios.md b/content/docs/scenarios.md index ed49cf6fd..07f502b69 100644 --- a/content/docs/scenarios.md +++ b/content/docs/scenarios.md @@ -11,7 +11,7 @@ As highlighted in the [features section]({{< relref "_index.md#features" >}}), K You may have encountered situations where the horizontal scaling of a cluster is impossible. When **only one Broker is throttling** and needs more CPU or requires additional disks (because it handles the most partitions), a StatefulSet-based solution is useless, since it does not distinguish between replicas' specifications. The handling of such a case requires *unique* Broker configurations. If there is a need to add a new disk to a unique Broker, there can be a waste of disk space (and money) with a StatefulSet-based solution, since it can't add a disk to a specific Broker, the StatefulSet adds one to each replica. -With the [Koperator](https://github.com/banzaicloud/koperator), adding a new disk to any Broker is as easy as changing a CR configuration. Similarly, any Broker-specific configuration can be done on a Broker by Broker basis. +With the [Koperator](https://github.com/adobe/koperator), adding a new disk to any Broker is as easy as changing a CR configuration. Similarly, any Broker-specific configuration can be done on a Broker by Broker basis. ## An unhandled error with Broker #1 in a three Broker cluster diff --git a/content/docs/ssl.md b/content/docs/ssl.md index ef6c2c0e6..3c72a6da1 100644 --- a/content/docs/ssl.md +++ b/content/docs/ssl.md @@ -31,7 +31,7 @@ If `sslSecrets.create` is `false`, the operator will look for the secret at `ssl ### Listeners not used for internal broker and controller communication -In [this **KafkaCluster** custom resource](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_hybrid_customcert.yaml), SSL is enabled for all listeners, and certificates are automatically generated for "inner" and "controller" listeners. The "external" and "internal" listeners will use the user-provided certificates. The **serverSSLCertSecret** key is a reference to the Kubernetes secret that contains the server certificate for the listener to be used for SSL communication. +In [this **KafkaCluster** custom resource](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_hybrid_customcert.yaml), SSL is enabled for all listeners, and certificates are automatically generated for "inner" and "controller" listeners. The "external" and "internal" listeners will use the user-provided certificates. The **serverSSLCertSecret** key is a reference to the Kubernetes secret that contains the server certificate for the listener to be used for SSL communication. In the server secret, the following keys must be set: @@ -45,7 +45,7 @@ The certificates in the listener configuration must be in JKS format. ### Listeners used for internal broker or controller communication -In [this **KafkaCluster** custom resource](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups_customcert.yaml), SSL is enabled for all listeners, and user-provided server certificates. In that case, when a custom certificate is used for a listener which is used for internal broker or controller communication, you must also specify the client certificate. The client certificate will be used by Koperator, Cruise Control, Cruise Control Metrics Reporter to communicate on SSL. The **clientSSLCertSecret** key is a reference to the Kubernetes secret where the custom client SSL certificate can be provided. The client certificate must be signed by the same CA authority as the server certificate for the corresponding listener. The **clientSSLCertSecret** has to be in the **KafkaCluster** custom resource spec field. +In [this **KafkaCluster** custom resource](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups_customcert.yaml), SSL is enabled for all listeners, and user-provided server certificates. In that case, when a custom certificate is used for a listener which is used for internal broker or controller communication, you must also specify the client certificate. The client certificate will be used by Koperator, Cruise Control, Cruise Control Metrics Reporter to communicate on SSL. The **clientSSLCertSecret** key is a reference to the Kubernetes secret where the custom client SSL certificate can be provided. The client certificate must be signed by the same CA authority as the server certificate for the corresponding listener. The **clientSSLCertSecret** has to be in the **KafkaCluster** custom resource spec field. The client secret must contain the keystore and truststore JKS files and the password for them in base64 encoded format. In the server secret the following keys must be set: diff --git a/content/docs/support.md b/content/docs/support.md index d9031f9b5..a60f21ad8 100644 --- a/content/docs/support.md +++ b/content/docs/support.md @@ -7,4 +7,4 @@ weight: 800 ## Community support -If you encounter problems while using Koperator that the documentation does not address, [open an issue](https://github.com/banzaicloud/kafka-operator/issues) or talk to us in our Slack channel [#kafka-operator](https://eti.cisco.com/slack). +If you encounter problems while using Koperator that the documentation does not address, [open an issue](https://github.com/adobe/koperator/issues) diff --git a/content/docs/troubleshooting/_index.md b/content/docs/troubleshooting/_index.md index 6a7e708aa..a04a7f4b4 100644 --- a/content/docs/troubleshooting/_index.md +++ b/content/docs/troubleshooting/_index.md @@ -185,7 +185,7 @@ status: ## Getting Support -If you encounter any problems that the documentation does not address, [file an issue](https://github.com/banzaicloud/koperator/issues) or talk to us on the Banzai Cloud Slack channel [#kafka-operator](https://slack.banzaicloud.io/). +If you encounter any problems that the documentation does not address, [file an issue](https://github.com/adobe/koperator/issues). Various [support]({{< relref "/docs/support.md">}}) channels are also available for Koperator. diff --git a/content/docs/upgrade-kafka-operator.md b/content/docs/upgrade-kafka-operator.md index 235236dc1..607f941cc 100644 --- a/content/docs/upgrade-kafka-operator.md +++ b/content/docs/upgrade-kafka-operator.md @@ -6,14 +6,14 @@ weight: 15 When upgrading your Koperator deployment to a new version, complete the following steps. -1. Download the CRDs for the new release from the [Koperator releases page](https://github.com/banzaicloud/koperator/releases). They are included in the assets of the release. +1. Download the CRDs for the new release from the [Koperator releases page](https://github.com/adobe/koperator/releases). They are included in the assets of the release. {{< warning >}}**Hazard of data loss** Do not delete the old CRD from the cluster. Deleting the CRD removes your Kafka cluster.{{< /warning >}} 1. Replace the KafkaCluster CRD with the new one on your cluster by running the following command (replace <versionnumber> with the release you are upgrading to, for example, **v0.14.0**). ```bash - kubectl replace --validate=false -f https://github.com/banzaicloud/koperator/releases/download//kafka-operator.crds.yaml + kubectl replace --validate=false -f https://github.com/adobe/koperator/releases/download//kafka-operator.crds.yaml ``` 1. Update your Koperator deployment by running: diff --git a/go.mod b/go.mod index a285533b4..adebf28f7 100644 --- a/go.mod +++ b/go.mod @@ -1,9 +1,10 @@ module github.com/openclarity/docs.openclarity.io -go 1.12 +go 1.24 require ( - github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 // indirect - github.com/google/docsy v0.7.1 // indirect - github.com/twbs/bootstrap v5.2.3+incompatible // indirect + github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 // indirect + github.com/google/docsy v0.12.0 // indirect + github.com/google/docsy/dependencies v0.7.2 // indirect + github.com/twbs/bootstrap v5.3.8+incompatible // indirect ) diff --git a/go.sum b/go.sum index e1d4ad4df..f1c25a2e9 100644 --- a/go.sum +++ b/go.sum @@ -1,22 +1,11 @@ -github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f h1:bvkUptSRPZBr3Kxuk+bnWCEmQ5MtEJX5fjezyV0bC3g= -github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4 h1:xfr9SidRCMEh4A8fdkLhFPcHAVbrdv3Ua0Jp/nSmhhQ= -github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 h1:Uv1z5EqCfmiK4IHUwT0m3h/u/WCk+kpRfxvAZhpC7Gc= github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= -github.com/google/docsy v0.5.1 h1:D/ZdFKiE29xM/gwPwQzmkyXhcbQGkReRS6aGrF7lnYk= -github.com/google/docsy v0.5.1/go.mod h1:maoUAQU5H/d+FrZIB4xg1EVWAx7RyFMGSDJyWghm31E= -github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI= -github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M= -github.com/google/docsy v0.7.0 h1:JaeZ0/KufX/BJ3SyATb/fmZa1DFI7o5d9KU+i6+lLJY= -github.com/google/docsy v0.7.0/go.mod h1:5WhIFchr5BfH6agjcInhpLRz7U7map0bcmKSpcrg6BE= -github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY= -github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc= -github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= -github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE= -github.com/google/docsy/dependencies v0.7.0/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= -github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= -github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o= -github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= -github.com/twbs/bootstrap v5.2.3+incompatible h1:lOmsJx587qfF7/gE7Vv4FxEofegyJlEACeVV+Mt7cgc= +github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w= +github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo= +github.com/google/docsy v0.12.0 h1:CddZKL39YyJzawr8GTVaakvcUTCJRAAYdz7W0qfZ2P4= +github.com/google/docsy v0.12.0/go.mod h1:1bioDqA493neyFesaTvQ9reV0V2vYy+xUAnlnz7+miM= +github.com/google/docsy/dependencies v0.7.2 h1:+t5ufoADQAj4XneFphz4A+UU0ICAxmNaRHVWtMYXPSI= +github.com/google/docsy/dependencies v0.7.2/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4= github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.6+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= +github.com/twbs/bootstrap v5.3.8+incompatible h1:eK1fsXP7R/FWFt+sSNmmvUH9usPocf240nWVw7Dh02o= +github.com/twbs/bootstrap v5.3.8+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0= diff --git a/layouts/partials/scripts.html b/layouts/partials/scripts.html index 0fc57004b..3ec9e12a7 100644 --- a/layouts/partials/scripts.html +++ b/layouts/partials/scripts.html @@ -62,9 +62,7 @@ {{ $jsBs := resources.Get "vendor/bootstrap/dist/js/bootstrap.bundle.js" -}} {{ $jsBase := resources.Get "js/base.js" -}} -{{ $jsAnchor := resources.Get "js/anchor.js" -}} {{ $jsSearch := resources.Get "js/search.js" | resources.ExecuteAsTemplate "js/search.js" .Site.Home -}} -{{ $jsMermaid := resources.Get "js/mermaid.js" | resources.ExecuteAsTemplate "js/mermaid.js" . -}} {{ $jsMarkmap := resources.Get "js/markmap.js" | resources.ExecuteAsTemplate "js/markmap.js" . -}} {{ $jsPlantuml := resources.Get "js/plantuml.js" | resources.ExecuteAsTemplate "js/plantuml.js" . -}} {{ $jsDrawio := resources.Get "js/drawio.js" | resources.ExecuteAsTemplate "js/drawio.js" . -}} @@ -72,11 +70,10 @@ {{ $jsSearch = resources.Get "js/offline-search.js" -}} {{ end -}} -{{ $jsArray := slice $jsBs $jsBase $jsAnchor $jsSearch $jsPlantuml $jsMarkmap $jsDrawio -}} +{{ $jsArray := slice $jsBs $jsBase $jsSearch $jsPlantuml $jsMarkmap $jsDrawio -}} {{ if $needmermaid -}} -{{ $jsArray = $jsArray | append $jsMermaid -}} - +{{- partial "scripts/mermaid.html" . -}} {{ end -}} {{ $js := $jsArray | resources.Concat "js/main.js" -}}