forked from rook/rook
Implement an allow list mechanism that disables potentially unsafe OBC fields by default. OBC fields beyond `maxObjects` and `maxSize` don't neatly fit into the OBC framework as it was originally envisioned and implemented. Some of the newly added configs could allow users to cause confusion for themselves. Others might allow users to hijack others buckets. Some might allow bricking the entire S3 store. Out of an abundance of safety, allow-list the known-safe options by default, and require administrators to enable potentially troublesome options via the new operator-level config `ROOK_OBC_ALLOW_ADDITIONAL_CONFIG_FIELDS`. Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
162 lines
5.9 KiB
Go
162 lines
5.9 KiB
Go
/*
|
|
Copyright 2021 The Rook Authors. All rights reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package operator
|
|
|
|
import (
|
|
"context"
|
|
|
|
"sigs.k8s.io/controller-runtime/pkg/client"
|
|
"sigs.k8s.io/controller-runtime/pkg/controller"
|
|
"sigs.k8s.io/controller-runtime/pkg/handler"
|
|
"sigs.k8s.io/controller-runtime/pkg/manager"
|
|
"sigs.k8s.io/controller-runtime/pkg/reconcile"
|
|
"sigs.k8s.io/controller-runtime/pkg/source"
|
|
|
|
"github.com/pkg/errors"
|
|
"github.com/rook/rook/pkg/clusterd"
|
|
opcontroller "github.com/rook/rook/pkg/operator/ceph/controller"
|
|
"github.com/rook/rook/pkg/operator/discover"
|
|
"github.com/rook/rook/pkg/operator/k8sutil"
|
|
"github.com/rook/rook/pkg/util"
|
|
v1 "k8s.io/api/core/v1"
|
|
kerrors "k8s.io/apimachinery/pkg/api/errors"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
)
|
|
|
|
const (
|
|
controllerName = "rook-ceph-operator-config-controller"
|
|
)
|
|
|
|
// ReconcileConfig reconciles a Ceph Operator config
|
|
type ReconcileConfig struct {
|
|
client client.Client
|
|
context *clusterd.Context
|
|
config opcontroller.OperatorConfig
|
|
opManagerContext context.Context
|
|
}
|
|
|
|
// Add creates a new Operator configuration Controller and adds it to the Manager. The Manager will set fields on the Controller
|
|
// and Start it when the Manager is Started.
|
|
func Add(mgr manager.Manager, context *clusterd.Context, opManagerContext context.Context, opConfig opcontroller.OperatorConfig) error {
|
|
return add(opManagerContext, context, mgr, newReconciler(mgr, context, opManagerContext, opConfig))
|
|
}
|
|
|
|
// newReconciler returns a new reconcile.Reconciler
|
|
func newReconciler(mgr manager.Manager, context *clusterd.Context, opManagerContext context.Context, config opcontroller.OperatorConfig) reconcile.Reconciler {
|
|
return &ReconcileConfig{
|
|
client: mgr.GetClient(),
|
|
context: context,
|
|
config: config,
|
|
opManagerContext: opManagerContext,
|
|
}
|
|
}
|
|
|
|
func add(ctx context.Context, context *clusterd.Context, mgr manager.Manager, r reconcile.Reconciler) error {
|
|
// Create a new controller
|
|
c, err := controller.New(controllerName, mgr, controller.Options{Reconciler: r})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
logger.Infof("%s successfully started", controllerName)
|
|
|
|
// Watch for ConfigMap (operator config)
|
|
s := source.Kind[client.Object](
|
|
mgr.GetCache(),
|
|
&v1.ConfigMap{TypeMeta: metav1.TypeMeta{Kind: "ConfigMap", APIVersion: v1.SchemeGroupVersion.String()}},
|
|
&handler.EnqueueRequestForObject{}, predicateController(ctx, mgr.GetClient()),
|
|
)
|
|
err = c.Watch(s)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Reconcile reads that state of the cluster for a CephClient object and makes changes based on the state read
|
|
// and what is in the CephClient.Spec
|
|
// The Controller will requeue the Request to be processed again if the returned error is non-nil or
|
|
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
|
|
func (r *ReconcileConfig) Reconcile(context context.Context, request reconcile.Request) (reconcile.Result, error) {
|
|
// workaround because the rook logging mechanism is not compatible with the controller-runtime logging interface
|
|
reconcileResponse, err := r.reconcile(request)
|
|
if err != nil {
|
|
logger.Errorf("failed to reconcile %v", err)
|
|
}
|
|
|
|
return reconcileResponse, err
|
|
}
|
|
|
|
func (r *ReconcileConfig) reconcile(request reconcile.Request) (reconcile.Result, error) {
|
|
// Fetch the operator's configmap
|
|
opConfig := &v1.ConfigMap{}
|
|
logger.Debugf("reconciling %s", request.NamespacedName)
|
|
err := r.client.Get(r.opManagerContext, request.NamespacedName, opConfig)
|
|
if err != nil {
|
|
if kerrors.IsNotFound(err) {
|
|
logger.Debug("operator's configmap resource not found. will use default value or env var.")
|
|
} else {
|
|
// Error reading the object - requeue the request.
|
|
return opcontroller.ImmediateRetryResult, errors.Wrap(err, "failed to get operator's configmap")
|
|
}
|
|
} else {
|
|
// Populate the operator's config
|
|
r.config.Parameters = opConfig.Data
|
|
}
|
|
|
|
// Reconcile Ceph CLI timeout, since the clusterd context is passed to by pointer to all CRD
|
|
// controllers they will receive the update
|
|
opcontroller.SetCephCommandsTimeout(r.config.Parameters)
|
|
|
|
// Reconcile Operator's logging level
|
|
reconcileOperatorLogLevel(opConfig.Data)
|
|
|
|
// Reconcile discovery daemon
|
|
err = r.reconcileDiscoveryDaemon(opConfig.Data)
|
|
if err != nil {
|
|
return opcontroller.ImmediateRetryResult, err
|
|
}
|
|
|
|
opcontroller.SetAllowLoopDevices(r.config.Parameters)
|
|
opcontroller.SetEnforceHostNetwork(r.config.Parameters)
|
|
opcontroller.SetRevisionHistoryLimit(r.config.Parameters)
|
|
opcontroller.SetObcAllowAdditionalConfigFields(r.config.Parameters)
|
|
|
|
logger.Infof("%s done reconciling", controllerName)
|
|
return reconcile.Result{}, nil
|
|
}
|
|
|
|
func reconcileOperatorLogLevel(data map[string]string) {
|
|
rookLogLevel := k8sutil.GetValue(data, "ROOK_LOG_LEVEL", util.DefaultLogLevel.String())
|
|
util.SetGlobalLogLevel(rookLogLevel, logger)
|
|
}
|
|
|
|
func (r *ReconcileConfig) reconcileDiscoveryDaemon(data map[string]string) error {
|
|
rookDiscover := discover.New(r.context.Clientset)
|
|
if opcontroller.DiscoveryDaemonEnabled(r.config.Parameters) {
|
|
if err := rookDiscover.Start(r.opManagerContext, r.config.OperatorNamespace, r.config.Image, r.config.ServiceAccount, data, true); err != nil {
|
|
return errors.Wrap(err, "failed to start device discovery daemonset")
|
|
}
|
|
} else {
|
|
if err := rookDiscover.Stop(r.opManagerContext, r.config.OperatorNamespace); err != nil {
|
|
return errors.Wrap(err, "failed to stop device discovery daemonset")
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|