You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit f25121a
Browse filesBrowse the repository at this point in the historyBrowse files
docs: rename master -> main in doc URLs (default branch rename 2/2)
Companion to the code-branch rename PR. Updates all adobe/koperator
`master` branch URLs in the published docs (raw CRD-apply/delete
commands, blob/tree source links, benchmark asset links) and the
crd-docs-generator template to `main`.
External `/master` links (confluentinc, prometheus/jmx_exporter) are
left unchanged. This branch (gh-pages) is not itself renamed.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: .github/crd-docs-generator/crd.template
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -202,6 +202,6 @@ This CRD is being replaced by <a href="../{{ .FullName }}/">{{ .ShortName }}</a>
202
202
{{ else }}
203
203
<div class="crd-noversions">
204
204
<p>We currently cannot show any schema information on this <abbr title="custom resource definition">CRD</abbr>. Sorry for the inconvenience!</p>
205
-
<p>Please refer to the <a href="https://pkg.go.dev/github.com/adobe/koperator/api/">Godoc</a> or <a href="https://github.com/adobe/koperator/tree/master/api">source</a> for details.</p>
205
+
<p>Please refer to the <a href="https://pkg.go.dev/github.com/adobe/koperator/api/">Godoc</a> or <a href="https://github.com/adobe/koperator/tree/main/api">source</a> for details.</p>
Copy file name to clipboardExpand all lines: content/docs/benchmarks/_index.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,10 +74,10 @@ How to setup the environment for the Kafka Performance Test.
74
74
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.
OCI registries have no floating "latest" tag, so `--version` is required:
@@ -90,7 +90,7 @@ How to setup the environment for the Kafka Performance Test.
90
90
--version {{< param "latest_version" >}}
91
91
```
92
92
93
-
1. Create a 3-broker Kafka Cluster using [this YAML file](https://raw.githubusercontent.com/adobe/koperator/master/docs/benchmarks/infrastructure/kafka.yaml).
93
+
1. Create a 3-broker Kafka Cluster using [this YAML file](https://raw.githubusercontent.com/adobe/koperator/main/docs/benchmarks/infrastructure/kafka.yaml).
94
94
95
95
This will install 3 brokers with fast SSD. If you would like the brokers in different zones, modify the following configurations to match your environment and use them in the broker configurations:
96
96
@@ -159,7 +159,7 @@ Monitoring environment is automatically installed. To monitor the infrastructure
159
159
160
160
## Run the tests
161
161
162
-
1. Run performance test against the cluster, by building [this Docker image](https://raw.githubusercontent.com/adobe/koperator/master/docs/benchmarks/loadgens/Dockerfile).
162
+
1. Run performance test against the cluster, by building [this Docker image](https://raw.githubusercontent.com/adobe/koperator/main/docs/benchmarks/loadgens/Dockerfile).
## Kafka cluster with custom SSL certificates for external listeners
34
34
35
35
You can specify custom SSL certificates for listeners.
36
36
For details about SSL configuration, see {{% xref "../../ssl.md" %}}.
37
37
38
-
-[Use custom SSL certificate for an external listener](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_external_ssl_customcert.yaml)
39
-
-[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.
40
-
-[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.
38
+
-[Use custom SSL certificate for an external listener](https://github.com/adobe/koperator/blob/main/config/samples/kafkacluster_with_external_ssl_customcert.yaml)
39
+
-[Use custom SSL certificate for controller and inter-broker communication](https://github.com/adobe/koperator/blob/main/config/samples/kafkacluster_with_ssl_groups_customcert.yaml). In this case you also need to provide the client SSL certificate for Koperator.
40
+
-[Hybrid solution](https://github.com/adobe/koperator/blob/main/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.
41
41
42
42
## Kafka cluster with SASL
43
43
44
44
You can use SASL authentication on the listeners.
45
45
For details, see {{% xref "../../external-listener/index.md" %}}.
46
46
47
-
-[Use SASL authentication on the listeners](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_with_sasl.yaml)
47
+
-[Use SASL authentication on the listeners](https://github.com/adobe/koperator/blob/main/config/samples/simplekafkacluster_with_sasl.yaml)
48
48
49
49
## Kafka cluster with load balancers and brokers in the same availability zone
50
50
51
51
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.
52
52
53
-
-[Load balancers and brokers in same availability zone](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster-with-brokerbindings.yaml)
53
+
-[Load balancers and brokers in same availability zone](https://github.com/adobe/koperator/blob/main/config/samples/simplekafkacluster-with-brokerbindings.yaml)
54
54
55
55
## Kafka cluster with custom advertised address for external listeners and brokers
56
56
@@ -59,24 +59,24 @@ This is useful when you're advertising the brokers on an IP address different fr
59
59
You can also set custom advertised address for external listeners.
60
60
For details, see {{% xref "../../external-listener/index.md" %}}.
61
61
62
-
-[Custom advertised address for external listeners](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster-with-nodeport-external.yaml)
62
+
-[Custom advertised address for external listeners](https://github.com/adobe/koperator/blob/main/config/samples/simplekafkacluster-with-nodeport-external.yaml)
63
63
64
64
## Kafka cluster with Kubernetes scheduler affinity settings
65
65
66
66
You can set node [affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) for your brokers.
You can deploy Kafka clusters using KRaft mode, which eliminates the need for ZooKeeper by using Kafka's built-in consensus mechanism. This is the future of Kafka and is recommended for new deployments.
79
79
80
-
-[Simple KafkaCluster with KRaft mode](https://github.com/adobe/koperator/blob/master/config/samples/kraft/simplekafkacluster_kraft.yaml)
80
+
-[Simple KafkaCluster with KRaft mode](https://github.com/adobe/koperator/blob/main/config/samples/kraft/simplekafkacluster_kraft.yaml)
81
81
82
82
For detailed information about KRaft configuration and deployment, see {{% xref "../../kraft.md" %}}.
Copy file name to clipboardExpand all lines: content/docs/cruisecontroloperation.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -163,7 +163,7 @@ status:
163
163
- The `state` shows the progress of the request.
164
164
- The `summary` is Cruise Control's optimization proposal. It shows the scope of the changes that Cruise Control will apply through the operation.
165
165
- 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).
166
-
For further information on the fields, see the [source code](https://github.com/adobe/koperator/blob/master/api/v1alpha1/cruisecontroloperation_types.go).
166
+
For further information on the fields, see the [source code](https://github.com/adobe/koperator/blob/main/api/v1alpha1/cruisecontroloperation_types.go).
167
167
168
168
## Control the created CruiseControlOperation {#control-cruisecontroloperation}
Copy file name to clipboardExpand all lines: content/docs/external-listener/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -127,7 +127,7 @@ To configure an external listener that uses the LoadBalancer access method, comp
127
127
tlsSecretName: heptio-contour/cluster-ssl
128
128
```
129
129
130
-
For a complete example, see the [Contour sample](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_with_contour.yaml).
130
+
For a complete example, see the [Contour sample](https://github.com/adobe/koperator/blob/main/config/samples/simplekafkacluster_with_contour.yaml).
131
131
132
132
1. Configure additional parameters for the ingress controller as needed for your environment, for example, number of replicas, resource requirements and resource limits. You can configure such parameters using the *envoyConfig* and *contourIngressConfig* fields, respectively.
133
133
1. (Optional) For external access through a static URL instead of the load balancer's public IP, specify the URL in the `hostnameOverride` field of the external listener that resolves to the public IP of the load balancer. The broker address will be advertised as, `advertised.listeners=EXTERNAL1://kafka-1.dev.my.domain:<broker port number>`.
Copy file name to clipboardExpand all lines: content/docs/install-kafka-operator.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -491,10 +491,10 @@ Koperator can be deployed using its [Helm chart](https://github.com/adobe/kopera
491
491
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.
- [KIP-500: Replace ZooKeeper with a Self-Managed Metadata Quorum](https://cwiki.apache.org/confluence/display/KAFKA/KIP-500%3A+Replace+ZooKeeper+with+a+Self-Managed+Metadata+Quorum)
0 commit comments