Skip to content

Support new authentication configuration format starting EnterpriseSearch 8.x #3728

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 5 commits into from
Sep 9, 2020
Merged

Support new authentication configuration format starting EnterpriseSearch 8.x #3728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5df9761
Support new auth config format starting EnterpriseSearch 8.x
thbkrkr Sep 8, 2020
a1a9717
Move comment
thbkrkr Sep 8, 2020
0130840
Update map type
thbkrkr Sep 8, 2020
7bda4a3
Unit test
thbkrkr Sep 8, 2020
9d37576
go fmt
thbkrkr Sep 8, 2020
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
32 changes: 25 additions & 7 deletions pkg/controller/enterprisesearch/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ import (
"net"
"path/filepath"

corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"

commonv1 "github.com/elastic/cloud-on-k8s/pkg/apis/common/v1"
entv1beta1 "github.com/elastic/cloud-on-k8s/pkg/apis/enterprisesearch/v1beta1"
"github.com/elastic/cloud-on-k8s/pkg/controller/association"
Expand All @@ -17,14 +22,11 @@ import (
"github.com/elastic/cloud-on-k8s/pkg/controller/common/driver"
"github.com/elastic/cloud-on-k8s/pkg/controller/common/reconciler"
"github.com/elastic/cloud-on-k8s/pkg/controller/common/settings"
"github.com/elastic/cloud-on-k8s/pkg/controller/common/version"
"github.com/elastic/cloud-on-k8s/pkg/controller/common/volume"
"github.com/elastic/cloud-on-k8s/pkg/controller/enterprisesearch/name"
"github.com/elastic/cloud-on-k8s/pkg/utils/k8s"
netutil "github.com/elastic/cloud-on-k8s/pkg/utils/net"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"
)

const (
Expand Down Expand Up @@ -251,16 +253,32 @@ func associationConfig(c k8s.Client, ent entv1beta1.EnterpriseSearch) (*settings
return settings.NewCanonicalConfig(), nil
}

cfg := settings.MustCanonicalConfig(map[string]string{
"ent_search.auth.source": "elasticsearch-native",
})
ver, err := version.Parse(ent.Spec.Version)
if err != nil {
return nil, err
}
// origin of authenticated ent users setting changed starting 8.x
if ver.IsSameOrAfter(version.From(8, 0, 0)) {
cfg = settings.MustCanonicalConfig(map[string]interface{}{
"ent_search.auth.native1.source": "elasticsearch-native",
"ent_search.auth.native1.order": -100,
})
}

username, password, err := association.ElasticsearchAuthSettings(c, &ent)
if err != nil {
return nil, err
}
cfg := settings.MustCanonicalConfig(map[string]string{
"ent_search.auth.source": "elasticsearch-native",
if err := cfg.MergeWith(settings.MustCanonicalConfig(map[string]string{
"elasticsearch.host": ent.AssociationConf().URL,
"elasticsearch.username": username,
"elasticsearch.password": password,
})
})); err != nil {
return nil, err
}

if ent.AssociationConf().CAIsConfigured() {
if err := cfg.MergeWith(settings.MustCanonicalConfig(map[string]interface{}{
Expand Down
81 changes: 78 additions & 3 deletions pkg/controller/enterprisesearch/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,15 @@ func secretWithConfig(name string, cfg []byte) *corev1.Secret {
}
}

func entWithAssociation(name string, associationConf commonv1.AssociationConf) entv1beta1.EnterpriseSearch {
func entWithAssociation(name string, version string, associationConf commonv1.AssociationConf) entv1beta1.EnterpriseSearch {
ent := entv1beta1.EnterpriseSearch{
ObjectMeta: metav1.ObjectMeta{
Namespace: "ns",
Name: name,
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: version,
},
}
ent.SetAssociationConf(&associationConf)
return ent
Expand Down Expand Up @@ -243,6 +246,9 @@ func TestReconcileConfig(t *testing.T) {
Namespace: "ns",
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
},
},
ipFamily: corev1.IPv4Protocol,
wantSecretEntries: []string{
Expand Down Expand Up @@ -272,6 +278,9 @@ func TestReconcileConfig(t *testing.T) {
Namespace: "ns",
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
},
},
ipFamily: corev1.IPv6Protocol,
wantSecretEntries: []string{
Expand Down Expand Up @@ -314,6 +323,9 @@ func TestReconcileConfig(t *testing.T) {
Namespace: "ns",
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
},
},
wantSecretEntries: []string{
"allow_es_settings_modification: true",
Expand All @@ -336,7 +348,56 @@ func TestReconcileConfig(t *testing.T) {
},
{
name: "with Elasticsearch association",
ent: entWithAssociation("sample", commonv1.AssociationConf{
ent: entWithAssociation("sample", "7.9.1", commonv1.AssociationConf{
AuthSecretName: "sample-ent-user",
AuthSecretKey: "ns-sample-ent-user",
CACertProvided: true,
CASecretName: "sample-ent-es-ca",
URL: "https://elasticsearch-sample-es-http.default.svc:9200",
}),
runtimeObjs: []runtime.Object{
&corev1.Secret{
ObjectMeta: metav1.ObjectMeta{
Namespace: "ns",
Name: "sample-ent-user",
},
Data: map[string][]byte{
"ns-sample-ent-user": []byte("mypassword"),
},
},
},
ipFamily: corev1.IPv4Protocol,
wantSecretEntries: []string{
"allow_es_settings_modification: true",
"elasticsearch:",
"host: https://elasticsearch-sample-es-http.default.svc:9200",
"password: mypassword",
"ssl:",
"certificate_authority: /mnt/elastic-internal/es-certs/tls.crt",
"enabled: true",
"username: ns-sample-ent-user",
"ent_search:",
"auth:",
"source: elasticsearch-native",
"external_url: https://localhost:3002",
"filebeat_log_directory: /var/log/enterprise-search",
"listen_host: 0.0.0.0",
"log_directory: /var/log/enterprise-search",
"ssl:",
"certificate: /mnt/elastic-internal/http-certs/tls.crt",
"certificate_authorities:",
"- /mnt/elastic-internal/http-certs/ca.crt",
"enabled: true",
"key: /mnt/elastic-internal/http-certs/tls.key",
"secret_management:",
"encryption_keys:",
"-", // don't check the actual encryption key
"secret_session_key:", // don't check the actual secret session key
},
},
{
name: "with Elasticsearch association, support new auth config starting 8x",
ent: entWithAssociation("sample", "8.0.0", commonv1.AssociationConf{
AuthSecretName: "sample-ent-user",
AuthSecretKey: "ns-sample-ent-user",
CACertProvided: true,
Expand Down Expand Up @@ -366,7 +427,9 @@ func TestReconcileConfig(t *testing.T) {
"username: ns-sample-ent-user",
"ent_search:",
"auth:",
"native1:",
"source: elasticsearch-native",
"order: -100",
"external_url: https://localhost:3002",
"filebeat_log_directory: /var/log/enterprise-search",
"listen_host: 0.0.0.0",
Expand All @@ -392,6 +455,7 @@ func TestReconcileConfig(t *testing.T) {
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
Config: &commonv1.Config{Data: map[string]interface{}{
"foo": "bar", // new setting
"ent_search.external_url": "https://my.own.dns.com", // override existing setting
Expand Down Expand Up @@ -438,6 +502,7 @@ func TestReconcileConfig(t *testing.T) {
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
Config: &commonv1.Config{Data: map[string]interface{}{
"foo": "bar", // new setting
"ent_search.external_url": "https://my.own.dns.com", // override existing setting
Expand Down Expand Up @@ -520,6 +585,9 @@ func TestReconcileConfig_ReadinessProbe(t *testing.T) {
Namespace: "ns",
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
},
},
ipFamily: corev1.IPv4Protocol,
wantCmd: `curl -g -o /dev/null -w "%{http_code}" https://127.0.0.1:3002/api/ent/v1/internal/health -k -s --max-time ${READINESS_PROBE_TIMEOUT}`, // no ES basic auth
Expand All @@ -532,6 +600,9 @@ func TestReconcileConfig_ReadinessProbe(t *testing.T) {
Namespace: "ns",
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
},
},
ipFamily: corev1.IPv6Protocol,
wantCmd: `curl -g -o /dev/null -w "%{http_code}" https://[::1]:3002/api/ent/v1/internal/health -k -s --max-time ${READINESS_PROBE_TIMEOUT}`, // no ES basic auth
Expand All @@ -554,13 +625,16 @@ func TestReconcileConfig_ReadinessProbe(t *testing.T) {
Namespace: "ns",
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.1",
},
},
ipFamily: corev1.IPv4Protocol,
wantCmd: `curl -g -o /dev/null -w "%{http_code}" https://127.0.0.1:3002/api/ent/v1/internal/health -k -s --max-time ${READINESS_PROBE_TIMEOUT}`, // no ES basic auth
},
{
name: "with ES association: use ES user credentials",
ent: entWithAssociation("sample", commonv1.AssociationConf{
ent: entWithAssociation("sample", "7.9.1", commonv1.AssociationConf{
AuthSecretName: "sample-ent-user",
AuthSecretKey: "ns-sample-ent-user",
CACertProvided: true,
Expand Down Expand Up @@ -600,6 +674,7 @@ func TestReconcileConfig_ReadinessProbe(t *testing.T) {
Name: "sample",
},
Spec: entv1beta1.EnterpriseSearchSpec{
Version: "7.9.0",
ConfigRef: &commonv1.ConfigSource{
SecretRef: commonv1.SecretRef{SecretName: "my-config"},
},
Expand Down