Skip to content

Commit

Permalink
Add options for ZK ACLs. (#144)
Browse files Browse the repository at this point in the history 
Signed-off-by: Houston Putman <[email protected]>
  • Loading branch information
@HoustonPutman @bsankara
HoustonPutman authored and bsankara committed Nov 12, 2020
1 parent 4312384 commit 30fa35b
Show file tree
Hide file tree
Showing 19 changed files with 1,241 additions and 125 deletions.
57 changes: 57 additions & 0 deletions api/v1beta1/common_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,3 +187,60 @@ func ImageVersion(image string) (version string) {
return split[1]
}
}

// SolrNodeStatus is the status of a solrNode in the cloud, with readiness status
// and internal and external addresses
type ZookeeperConnectionInfo struct {
// The connection string to connect to the ensemble from within the Kubernetes cluster
// +optional
InternalConnectionString string `json:"internalConnectionString,omitempty"`

// The connection string to connect to the ensemble from outside of the Kubernetes cluster
// If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
// +optional
ExternalConnectionString *string `json:"externalConnectionString,omitempty"`

// The ChRoot to connect solr at
// +optional
ChRoot string `json:"chroot,omitempty"`

// ZooKeeper ACL to use when connecting with ZK.
// This ACL should have ALL permission in the given chRoot.
// +optional
AllACL *ZookeeperACL `json:"acl,omitempty"`

// ZooKeeper ACL to use when connecting with ZK for reading operations.
// This ACL should have READ permission in the given chRoot.
// +optional
ReadOnlyACL *ZookeeperACL `json:"readOnlyAcl,omitempty"`
}

func (ci *ZookeeperConnectionInfo) withDefaults() (changed bool) {
if ci.InternalConnectionString == "" {
if ci.ExternalConnectionString != nil {
changed = true
ci.InternalConnectionString = *ci.ExternalConnectionString
}
}
if ci.ChRoot == "" {
changed = true
ci.ChRoot = "/"
} else if !strings.HasPrefix(ci.ChRoot, "/") {
changed = true
ci.ChRoot = "/" + ci.ChRoot
}
return changed
}

// ZookeeperSpec defines the internal zookeeper ensemble to run for solr
type ZookeeperACL struct {
// The name of the Kubernetes Secret that stores the username and password for the ACL.
// This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
SecretRef string `json:"secret"`

// The name of the key in the given secret that contains the ACL username
UsernameKey string `json:"usernameKey"`

// The name of the key in the given secret that contains the ACL password
PasswordKey string `json:"passwordKey"`
}
34 changes: 0 additions & 34 deletions api/v1beta1/solrcloud_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -403,23 +403,6 @@ func (ref *ZookeeperRef) withDefaults() (changed bool) {
return changed
}

func (ci *ZookeeperConnectionInfo) withDefaults() (changed bool) {
if ci.InternalConnectionString == "" {
if ci.ExternalConnectionString != nil {
changed = true
ci.InternalConnectionString = *ci.ExternalConnectionString
}
}
if ci.ChRoot == "" {
changed = true
ci.ChRoot = "/"
} else if !strings.HasPrefix(ci.ChRoot, "/") {
changed = true
ci.ChRoot = "/" + ci.ChRoot
}
return changed
}

// ZookeeperSpec defines the internal zookeeper ensemble to run with the given spec
type ZookeeperSpec struct {
// DEPRECATED: Will be removed in v0.3.0
Expand Down Expand Up @@ -654,23 +637,6 @@ type SolrNodeStatus struct {
Version string `json:"version"`
}

// SolrNodeStatus is the status of a solrNode in the cloud, with readiness status
// and internal and external addresses
type ZookeeperConnectionInfo struct {
// The connection string to connect to the ensemble from within the Kubernetes cluster
// +optional
InternalConnectionString string `json:"internalConnectionString,omitempty"`

// The connection string to connect to the ensemble from outside of the Kubernetes cluster
// If external and no internal connection string is provided, the external cnx string will be used as the internal cnx string
// +optional
ExternalConnectionString *string `json:"externalConnectionString,omitempty"`

// The ChRoot to connect solr at
// +optional
ChRoot string `json:"chroot,omitempty"`
}

// +kubebuilder:object:root=true
// +kubebuilder:resource:scope=Namespaced

Expand Down
2 changes: 1 addition & 1 deletion api/v1beta1/solrprometheusexporter_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ type SolrCloudReference struct {
// +optional
Namespace string `json:"namespace,omitempty"`

// The ZK Connection information for a cloud, could be used for solr's outside of the kube cluster
// The ZK Connection information for a cloud, could be used for solr's running outside of the kube cluster
// +optional
ZookeeperConnectionInfo *ZookeeperConnectionInfo `json:"zkConnectionInfo,omitempty"`
}
Expand Down
25 changes: 25 additions & 0 deletions api/v1beta1/zz_generated.deepcopy.go
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

68 changes: 68 additions & 0 deletions config/crd/bases/solr.bloomberg.com_solrclouds.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3354,6 +3354,23 @@ spec:
connectionInfo:
description: A zookeeper ensemble that is run independently of the solr operator If an externalConnectionString is provided, but no internalConnectionString is, the external will be used as the internal
properties:
acl:
description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
description: The name of the key in the given secret that contains the ACL password
type: string
secret:
description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
type: string
usernameKey:
description: The name of the key in the given secret that contains the ACL username
type: string
required:
- passwordKey
- secret
- usernameKey
type: object
chroot:
description: The ChRoot to connect solr at
type: string
Expand All @@ -3363,6 +3380,23 @@ spec:
internalConnectionString:
description: The connection string to connect to the ensemble from within the Kubernetes cluster
type: string
readOnlyAcl:
description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
properties:
passwordKey:
description: The name of the key in the given secret that contains the ACL password
type: string
secret:
description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
type: string
usernameKey:
description: The name of the key in the given secret that contains the ACL username
type: string
required:
- passwordKey
- secret
- usernameKey
type: object
type: object
provided:
description: 'Create a new Zookeeper Ensemble with the following spec Note: This option will not allow the SolrCloud to run across kube-clusters. Note: Requires - The zookeeperOperator flag to be provided to the Solr Operator - A zookeeper operator to be running'
Expand Down Expand Up @@ -4533,6 +4567,23 @@ spec:
zookeeperConnectionInfo:
description: ZookeeperConnectionInfo is the information on how to connect to the used Zookeeper
properties:
acl:
description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
description: The name of the key in the given secret that contains the ACL password
type: string
secret:
description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
type: string
usernameKey:
description: The name of the key in the given secret that contains the ACL username
type: string
required:
- passwordKey
- secret
- usernameKey
type: object
chroot:
description: The ChRoot to connect solr at
type: string
Expand All @@ -4542,6 +4593,23 @@ spec:
internalConnectionString:
description: The connection string to connect to the ensemble from within the Kubernetes cluster
type: string
readOnlyAcl:
description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
properties:
passwordKey:
description: The name of the key in the given secret that contains the ACL password
type: string
secret:
description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
type: string
usernameKey:
description: The name of the key in the given secret that contains the ACL username
type: string
required:
- passwordKey
- secret
- usernameKey
type: object
type: object
required:
- backupRestoreReady
Expand Down
36 changes: 35 additions & 1 deletion config/crd/bases/solr.bloomberg.com_solrprometheusexporters.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2262,8 +2262,25 @@ spec:
description: The namespace of a solr cloud running within the kubernetes cluster
type: string
zkConnectionInfo:
description: The ZK Connection information for a cloud, could be used for solr's outside of the kube cluster
description: The ZK Connection information for a cloud, could be used for solr's running outside of the kube cluster
properties:
acl:
description: ZooKeeper ACL to use when connecting with ZK. This ACL should have ALL permission in the given chRoot.
properties:
passwordKey:
description: The name of the key in the given secret that contains the ACL password
type: string
secret:
description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
type: string
usernameKey:
description: The name of the key in the given secret that contains the ACL username
type: string
required:
- passwordKey
- secret
- usernameKey
type: object
chroot:
description: The ChRoot to connect solr at
type: string
Expand All @@ -2273,6 +2290,23 @@ spec:
internalConnectionString:
description: The connection string to connect to the ensemble from within the Kubernetes cluster
type: string
readOnlyAcl:
description: ZooKeeper ACL to use when connecting with ZK for reading operations. This ACL should have READ permission in the given chRoot.
properties:
passwordKey:
description: The name of the key in the given secret that contains the ACL password
type: string
secret:
description: The name of the Kubernetes Secret that stores the username and password for the ACL. This secret must be in the same namespace as the solrCloud or prometheusExporter is running in.
type: string
usernameKey:
description: The name of the key in the given secret that contains the ACL username
type: string
required:
- passwordKey
- secret
- usernameKey
type: object
type: object
type: object
standalone:
Expand Down
9 changes: 9 additions & 0 deletions controllers/controller_utils_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,14 @@ func expectDeployment(t *testing.T, g *gomega.GomegaWithT, requests chan reconci
}

func testPodEnvVariables(t *testing.T, expectedEnvVars map[string]string, foundEnvVars []corev1.EnvVar) {
testGenericPodEnvVariables(t, expectedEnvVars, foundEnvVars, "SOLR_OPTS")
}

func testMetricsPodEnvVariables(t *testing.T, expectedEnvVars map[string]string, foundEnvVars []corev1.EnvVar) {
testGenericPodEnvVariables(t, expectedEnvVars, foundEnvVars, "JAVA_OPTS")
}

func testGenericPodEnvVariables(t *testing.T, expectedEnvVars map[string]string, foundEnvVars []corev1.EnvVar, lastVarName string) {
matchCount := 0
for _, envVar := range foundEnvVars {
if expectedVal, match := expectedEnvVars[envVar.Name]; match {
Expand All @@ -186,6 +194,7 @@ func testPodEnvVariables(t *testing.T, expectedEnvVars map[string]string, foundE
}
}
assert.Equal(t, len(expectedEnvVars), matchCount, "Not all expected env variables found in podSpec")
assert.Equal(t, lastVarName, foundEnvVars[len(foundEnvVars)-1].Name, lastVarName+" must be the last envVar set, as it uses other envVars.")
}

func testPodTolerations(t *testing.T, expectedTolerations []corev1.Toleration, foundTolerations []corev1.Toleration) {
Expand Down
Loading

0 comments on commit 30fa35b

Please sign in to comment.