Skip to content

Better fields descriptions #393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 10, 2022
Merged

Better fields descriptions #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25efb43
Improve fields descriptions in secretBackend.Vault
ChunyiLyu Jun 10, 2022
325e902
Fix incorrect unit test description
ChunyiLyu Jun 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions api/v1beta1/schemareplication_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,21 @@ type SchemaReplicationSpec struct {
// When endpoints are provided in both spec.endpoints and spec.upstreamSecret, spec.endpoints takes
// precedence.
Endpoints string `json:"endpoints,omitempty"`
// Secret backend configuration for the RabbitmqCluster.
// Enables to fetch default user credentials and certificates from K8s external secret stores.
// Set to fetch user credentials from K8s external secret stores to be used for schema replication.
SecretBackend SecretBackend `json:"secretBackend,omitempty"`
}

// SecretBackend configures a single secret backend.
// Today, only Vault exists as supported secret backend.
// Future secret backends could be Secrets Store CSI Driver.
// If not configured, K8s Secrets will be used.
type SecretBackend struct {
Vault *VaultSpec `json:"vault,omitempty"`
}

type VaultSpec struct {
// Path in Vault to access a KV (Key-Value) secret with the fields username and password to be used for schema replication.
// Path in Vault to access a KV (Key-Value) secret with the fields username and password to be used for replication.
// For example "secret/data/rabbitmq/config".
// Optional; if not provided, username and password will come from spec.upstreamSecret.
// Have to set either secretBackend.vault.secretPath or spec.upstreamSecret, but not both.
// Optional; if not provided, username and password will come from upstreamSecret instead.
// Have to set either secretBackend.vault.secretPath or upstreamSecret, but not both.
SecretPath string `json:"secretPath,omitempty"`
}

Expand Down
2 changes: 1 addition & 1 deletion api/v1beta1/schemareplication_webhook_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ var _ = Describe("schema-replication webhook", func() {
Expect(updated.ValidateUpdate(&replication)).To(Succeed())
})

It("allows updates on rabbitmqClusterReference.connectionSecret", func() {
It("does not allow updates on rabbitmqClusterReference.connectionSecret", func() {
connectionScr := SchemaReplication{
ObjectMeta: metav1.ObjectMeta{
Name: "test-replication",
Expand Down
15 changes: 7 additions & 8 deletions config/crd/bases/rabbitmq.com_schemareplications.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,18 @@ spec:
type: string
type: object
secretBackend:
description: Secret backend configuration for the RabbitmqCluster.
Enables to fetch default user credentials and certificates from
K8s external secret stores.
description: Set to fetch user credentials from K8s external secret
stores to be used for schema replication.
properties:
vault:
properties:
secretPath:
description: Path in Vault to access a KV (Key-Value) secret
with the fields username and password to be used for schema
replication. For example "secret/data/rabbitmq/config".
Optional; if not provided, username and password will come
from spec.upstreamSecret. Have to set either secretBackend.vault.secretPath
or spec.upstreamSecret, but not both.
with the fields username and password to be used for replication.
For example "secret/data/rabbitmq/config". Optional; if
not provided, username and password will come from upstreamSecret
instead. Have to set either secretBackend.vault.secretPath
or upstreamSecret, but not both.
type: string
type: object
type: object
Expand Down
6 changes: 3 additions & 3 deletions docs/api/rabbitmq.com.ref.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,7 +766,7 @@ SchemaReplicationSpec defines the desired state of SchemaReplication
| *`rabbitmqClusterReference`* __xref:{anchor_prefix}-github-com-rabbitmq-messaging-topology-operator-api-v1beta1-rabbitmqclusterreference[$$RabbitmqClusterReference$$]__ | Reference to the RabbitmqCluster that schema replication would be set for. Must be an existing cluster.
| *`upstreamSecret`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core[$$LocalObjectReference$$]__ | Defines a Secret which contains credentials to be used for schema replication. The Secret must contain the keys `username` and `password` in its Data field, or operator will error. Have to set either secretBackend.vault.secretPath or spec.upstreamSecret, but not both.
| *`endpoints`* __string__ | endpoints should be one or multiple endpoints separated by ','. Must provide either spec.endpoints or endpoints in spec.upstreamSecret. When endpoints are provided in both spec.endpoints and spec.upstreamSecret, spec.endpoints takes precedence.
| *`secretBackend`* __xref:{anchor_prefix}-github-com-rabbitmq-messaging-topology-operator-api-v1beta1-secretbackend[$$SecretBackend$$]__ | Secret backend configuration for the RabbitmqCluster. Enables to fetch default user credentials and certificates from K8s external secret stores.
| *`secretBackend`* __xref:{anchor_prefix}-github-com-rabbitmq-messaging-topology-operator-api-v1beta1-secretbackend[$$SecretBackend$$]__ | Set to fetch user credentials from K8s external secret stores to be used for schema replication.
|===


Expand All @@ -791,7 +791,7 @@ SchemaReplicationStatus defines the observed state of SchemaReplication
[id="{anchor_prefix}-github-com-rabbitmq-messaging-topology-operator-api-v1beta1-secretbackend"]
==== SecretBackend

SecretBackend configures a single secret backend. Today, only Vault exists as supported secret backend. Future secret backends could be Secrets Store CSI Driver. If not configured, K8s Secrets will be used.
SecretBackend configures a single secret backend. Today, only Vault exists as supported secret backend.

.Appears In:
****
Expand Down Expand Up @@ -1013,7 +1013,7 @@ UserTag defines the level of access to the management UI allocated to the user.
[cols="25a,75a", options="header"]
|===
| Field | Description
| *`secretPath`* __string__ | Path in Vault to access a KV (Key-Value) secret with the fields username and password to be used for schema replication. For example "secret/data/rabbitmq/config". Optional; if not provided, username and password will come from spec.upstreamSecret. Have to set either secretBackend.vault.secretPath or spec.upstreamSecret, but not both.
| *`secretPath`* __string__ | Path in Vault to access a KV (Key-Value) secret with the fields username and password to be used for replication. For example "secret/data/rabbitmq/config". Optional; if not provided, username and password will come from upstreamSecret instead. Have to set either secretBackend.vault.secretPath or upstreamSecret, but not both.
|===


Expand Down