Add the support of custom logging configuration for cockroach version greater than v21.1 (#827)

* Add the support of custom logging configuration for cockroach version greater than v21.1

* Add the support of custom logging configuration through the provided configmap

* Add the logging.yaml key in log configmap

* Add the change entry in CHANGELOG.md

Author: prafull01

CHANGELOG.md

@@ -7,6 +7,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 # [Unreleased](https://github.com/cockroachdb/cockroach-operator/compare/v2.5.3...master)
 
+## Added
+
+* Custom logging configuration can be used through the configmap when `spec.logConfigMap` is provided.
+
 # [v2.5.3](https://github.com/cockroachdb/cockroach-operator/compare/v2.5.2...v2.5.3)
 
 ## Fixed

apis/v1alpha1/cluster_types.go

@@ -130,6 +130,13 @@ type CrdbClusterSpec struct {
 	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Cockroach Database Ingress"
 	// +optional
 	Ingress *IngressConfig `json:"ingress,omitempty"`
+	// (Optional) LogConfigMap define the config map which contains log configuration used to send the logs through the
+	// proper channels in the cockroachdb. Logging configuration is available for cockroach version v21.1.0 onwards.
+	// The logging configuration is taken in format of yaml file, you can check the logging configuration here (https://www.cockroachlabs.com/docs/stable/configure-logs.html#default-logging-configuration)
+	// The default logging for cockroach version v20.x or less is stderr, logging API is ignored for older versions.
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Cockroach Database Logging configuration config map"
+	// +optional
+	LogConfigMap string `json:"logConfigMap,omitempty"`
 }
 
 // +k8s:openapi-gen=true

apis/v1alpha1/webhook.go

@@ -180,4 +180,4 @@ func (r *CrdbCluster) ValidateVolumeMode() error {
 			"you have provided unsupported pvc.volumeMode, currently only Filesystem is supported.")
 	}
 	return nil
-}
+}

apis/v1alpha1/webhook_test.go

@@ -102,8 +102,7 @@ func TestCreateCrdbCluster(t *testing.T) {
 				Image: &PodImage{Name: "testImage"},
 				DataStore: Volume{
 					VolumeClaim: &VolumeClaim{
-						PersistentVolumeClaimSpec: v1.PersistentVolumeClaimSpec{
-						},
+						PersistentVolumeClaimSpec: v1.PersistentVolumeClaimSpec{},
 					},
 				},
 			}},

config/crd/bases/crdb.cockroachlabs.com_crdbclusters.yaml

@@ -973,6 +973,15 @@ spec:
                     - host
                     type: object
                 type: object
+              logConfigMap:
+                description: (Optional) LogConfigMap define the config map which contains
+                  log configuration used to send the logs through the proper channels
+                  in the cockroachdb. Logging configuration is available for cockroach
+                  version v21.1.0 onwards. The logging configuration is taken in format
+                  of yaml file, you can check the logging configuration here (https://www.cockroachlabs.com/docs/stable/configure-logs.html#default-logging-configuration)
+                  The default logging for cockroach version v20.x or less is stderr,
+                  logging API is ignored for older versions.
+                type: string
               maxSQLMemory:
                 description: '(Optional) The maximum in-memory storage capacity available
                   to store temporary data for SQL queries (`--max-sql-memory` parameter)

config/rbac/role.yaml

@@ -128,6 +128,8 @@ rules:
   - configmaps
   verbs:
   - get
+  - list
+  - watch
 - apiGroups:
   - ""
   resources:

e2e/create/create_test.go

@@ -17,6 +17,7 @@ limitations under the License.
 package e2e
 
 import (
+	"encoding/json"
 	"os"
 	"testing"
 
@@ -54,8 +55,14 @@ func TestCreateInsecureCluster(t *testing.T) {
 	sb := testenv.NewDiffingSandbox(t, env)
 	sb.StartManager(t, controller.InitClusterReconcilerWithLogger(testLog))
 
+	// Create cluster with different logging config than the default one.
+	logJson := []byte(`{"sinks": {"file-groups": {"dev": {"channels": "DEV", "filter": "WARNING"}}}}`)
+	logConfig := make(map[string]interface{})
+	require.NoError(t, json.Unmarshal(logJson, &logConfig))
+	testutil.RequireLoggingConfigMap(t, sb, "logging-configmap", string(logJson))
+
 	builder := testutil.NewBuilder("crdb").WithNodeCount(3).
-		WithImage(e2e.MajorVersion).
+		WithImage(e2e.MajorVersion).WithClusterLogging("logging-configmap").
 		WithPVDataStore("1Gi", "standard" /* default storage class in KIND */)
 
 	steps := testutil.Steps{

e2e/versionchecker/BUILD.bazel

@@ -5,6 +5,7 @@ go_test(
     size = "enormous",
     srcs = ["versionchecker_test.go"],
     deps = [
+        "//apis/v1alpha1:go_default_library",
         "//e2e:go_default_library",
         "//pkg/controller:go_default_library",
         "//pkg/testutil:go_default_library",
@@ -13,6 +14,7 @@ go_test(
         "@com_github_stretchr_testify//require:go_default_library",
         "@io_k8s_api//core/v1:go_default_library",
         "@io_k8s_apimachinery//pkg/api/resource:go_default_library",
+        "@io_k8s_apimachinery//pkg/apis/meta/v1:go_default_library",
         "@org_uber_go_zap//zaptest:go_default_library",
     ],
 )

e2e/versionchecker/versionchecker_test.go

@@ -17,12 +17,15 @@ limitations under the License.
 package versionchecker_test
 
 import (
+	"encoding/json"
 	"testing"
 	"time"
 
 	corev1 "k8s.io/api/core/v1"
 	apiresource "k8s.io/apimachinery/pkg/api/resource"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 
+	crdbv1alpha1 "github.com/cockroachdb/cockroach-operator/apis/v1alpha1"
 	"github.com/cockroachdb/cockroach-operator/e2e"
 	"github.com/cockroachdb/cockroach-operator/pkg/controller"
 	"github.com/cockroachdb/cockroach-operator/pkg/testutil"
@@ -70,3 +73,47 @@ func TestVersionCheckerJobPodPending(t *testing.T) {
 	}
 	steps.Run(t)
 }
+
+func TestLoggingAPIValidCheck(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping test in short mode.")
+	}
+	testLog := zapr.NewLogger(zaptest.NewLogger(t))
+
+	e := testenv.CreateActiveEnvForTest()
+	env := e.Start()
+	defer e.Stop()
+
+	sb := testenv.NewDiffingSandbox(t, env)
+	sb.StartManager(t, controller.InitClusterReconcilerWithLogger(testLog))
+
+	logJson := []byte(`{"sinkss": "invalidvalue"}`)
+	logConfig := make(map[string]interface{})
+	require.NoError(t, json.Unmarshal(logJson, &logConfig))
+	testutil.RequireLoggingConfigMap(t, sb, "logging-configmap", string(logJson))
+
+	builder := testutil.NewBuilder("crdb").Namespaced(sb.Namespace).WithNodeCount(3).WithTLS().
+		WithImage("cockroachdb/cockroach:v21.1.0").
+		WithPVDataStore("32Mi", "standard" /* default storage class in KIND */).
+		WithClusterLogging("logging-configmap")
+
+	steps := testutil.Steps{
+		{
+			Name: "validate the logging API input",
+			Test: func(t *testing.T) {
+				require.NoError(t, sb.Create(builder.Cr()))
+				crdbCluster := &crdbv1alpha1.CrdbCluster{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:      builder.Cr().Name,
+						Namespace: builder.Cr().Namespace,
+					},
+				}
+				// Added sleep to reconcile the CR.
+				time.Sleep(2 * time.Second)
+				require.NoError(t, sb.Get(crdbCluster))
+				require.Equal(t, crdbCluster.Status.ClusterStatus, "Failed")
+			},
+		},
+	}
+	steps.Run(t)
+}

hack/bin/deps.bzl

@@ -442,13 +442,13 @@ filegroup(
 def install_crdb():
     http_archive(
        name = "crdb_darwin", # todo fix or remove
-       sha256 = "bbe3a03c661555e8b083856c56c8a3b459f83064d1d552ed3467cbfb66e76db7",
-       urls = ["https://binaries.cockroachdb.com/cockroach-v20.2.5.darwin-10.9-amd64.tgz"],
+       sha256 = "bbbd0a75f81d3df4acd139fdc7f0961480161454db24f25263c9276c3959db54",
+       urls = ["https://binaries.cockroachdb.com/cockroach-v21.2.0.darwin-10.9-amd64.tgz"],
        build_file_content = """
 filegroup(
     name = "file",
     srcs = [
-        "cockroach-v20.2.5.darwin-10.9-amd64/cockroach",
+        "cockroach-v21.2.0.darwin-10.9-amd64/cockroach",
     ],
     visibility = ["//visibility:public"],
 )
@@ -457,13 +457,13 @@ filegroup(
 
     http_archive(
         name = "crdb_linux",
-        sha256 = "57f4b00c736d8511328d6f33997a3a66cb4ec7142cb126d872dade399a0922e6",
-        urls = ["https://binaries.cockroachdb.com/cockroach-v20.2.5.linux-amd64.tgz"],
+        sha256 = "c9fda447b9db98ade4444f5855ceb6ffe94549a20bd7cad8fdf70c398add8c02",
+        urls = ["https://binaries.cockroachdb.com/cockroach-v21.2.0.linux-amd64.tgz"],
         build_file_content = """
 filegroup(
     name = "file",
     srcs = [
-        "cockroach-v20.2.5.linux-amd64/cockroach",
+        "cockroach-v21.2.0.linux-amd64/cockroach",
     ],
     visibility = ["//visibility:public"],
 )