Skip to content

Add safe-start capability #287

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

Draft
chlunde wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add safe-start capability #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions cluster/local/integration_tests.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,12 @@ setup_crossplane() {
setup_provider() {
echo_step "installing provider"

echo_sub_step "applying ManagedResourceActivationPolicy to disable cluster-wide MSSQL"
"${KUBECTL}" apply -f "${projectdir}/examples/activation-policy-no-cluster-mssql.yaml"

echo_sub_step "deleting default ManagedResourceActivationPolicy that activates everything"
"${KUBECTL}" delete managedresourceactivationpolicy default --ignore-not-found=true

local yaml="$( cat <<EOF
apiVersion: pkg.crossplane.io/v1beta1
kind: DeploymentRuntimeConfig
Expand Down Expand Up @@ -212,13 +218,32 @@ EOF

echo_step "waiting for provider to be installed"
"${KUBECTL}" wait "provider.pkg.crossplane.io/${PACKAGE_NAME}" --for=condition=healthy --timeout=60s

echo_step "verifying cluster-wide MSSQL CRDs are NOT installed"
if "${KUBECTL}" get crd databases.mssql.sql.crossplane.io 2>/dev/null; then
echo_error "cluster-wide MSSQL Database CRD should not be installed"
fi
if "${KUBECTL}" get crd grants.mssql.sql.crossplane.io 2>/dev/null; then
echo_error "cluster-wide MSSQL Grant CRD should not be installed"
fi
if "${KUBECTL}" get crd users.mssql.sql.crossplane.io 2>/dev/null; then
echo_error "cluster-wide MSSQL User CRD should not be installed"
fi
echo_step_completed

echo_step "verifying namespaced MSSQL CRDs ARE installed"
"${KUBECTL}" get crd databases.mssql.sql.m.crossplane.io || echo_error "namespaced MSSQL Database CRD should be installed"
"${KUBECTL}" get crd grants.mssql.sql.m.crossplane.io || echo_error "namespaced MSSQL Grant CRD should be installed"
"${KUBECTL}" get crd users.mssql.sql.m.crossplane.io || echo_error "namespaced MSSQL User CRD should be installed"
echo_step_completed
}

cleanup_provider() {
echo_step "uninstalling provider"

"${KUBECTL}" delete provider.pkg.crossplane.io "${PACKAGE_NAME}"
"${KUBECTL}" delete deploymentruntimeconfig.pkg.crossplane.io debug-config
"${KUBECTL}" delete managedresourceactivationpolicy.apiextensions.crossplane.io disable-cluster-mssql --ignore-not-found=true

echo_step "waiting for provider pods to be deleted"
timeout=60
Expand Down
48 changes: 47 additions & 1 deletion cmd/provider/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ limitations under the License.
package main

import (
"context"
"os"
"path/filepath"

Expand All @@ -25,19 +26,46 @@ import (
_ "github.com/lib/pq"

"github.com/alecthomas/kingpin/v2"
authv1 "k8s.io/api/authorization/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/log/zap"

xpcontroller "github.com/crossplane/crossplane-runtime/v2/pkg/controller"
"github.com/crossplane/crossplane-runtime/v2/pkg/feature"
"github.com/crossplane/crossplane-runtime/v2/pkg/gate"
"github.com/crossplane/crossplane-runtime/v2/pkg/logging"
"github.com/crossplane/crossplane-runtime/v2/pkg/ratelimiter"
"github.com/crossplane/crossplane-runtime/v2/pkg/reconciler/customresourcesgate"

"github.com/crossplane-contrib/provider-sql/apis"
"github.com/crossplane-contrib/provider-sql/pkg/controller"
)

// canWatchCRD checks if the provider has the necessary RBAC permissions to watch CustomResourceDefinitions.
// This is used to determine if we can use the SafeStart pattern with gated controller initialization.
func canWatchCRD(ctx context.Context, c client.Client) (bool, error) {
review := &authv1.SelfSubjectAccessReview{
Spec: authv1.SelfSubjectAccessReviewSpec{
ResourceAttributes: &authv1.ResourceAttributes{
Group: apiextensionsv1.GroupName,
Version: "*",
Resource: "customresourcedefinitions",
Verb: "list",
},
},
}

if err := c.Create(ctx, review); err != nil {
return false, err
}

return review.Status.Allowed, nil
}

func main() {
var (
app = kingpin.New(filepath.Base(os.Args[0]), "SQL support for Crossplane.").DefaultEnvars()
Expand Down Expand Up @@ -73,6 +101,7 @@ func main() {
})
kingpin.FatalIfError(err, "Cannot create controller manager")
kingpin.FatalIfError(apis.AddToScheme(mgr.GetScheme()), "Cannot add SQL APIs to scheme")
kingpin.FatalIfError(apiextensionsv1.AddToScheme(mgr.GetScheme()), "Cannot add CRD types to scheme")

o := xpcontroller.Options{
Logger: log,
Expand All @@ -86,6 +115,23 @@ func main() {
log.Info("Beta feature enabled", "flag", feature.EnableBetaManagementPolicies)
}

kingpin.FatalIfError(controller.Setup(mgr, o), "Cannot setup SQL controllers")
// Check if we have permission to watch CRDs for SafeStart support
ctx := context.Background()
canWatch, err := canWatchCRD(ctx, mgr.GetClient())
switch {
case err != nil:
log.Info("Failed to check CRD watch permissions, using immediate controller setup", "error", err)
kingpin.FatalIfError(controller.Setup(mgr, o), "Cannot setup SQL controllers")
case canWatch:
log.Info("SafeStart enabled: using gated controller initialization")
o.Gate = new(gate.Gate[schema.GroupVersionKind])

kingpin.FatalIfError(customresourcesgate.Setup(mgr, o), "Cannot setup CRD gate")
kingpin.FatalIfError(controller.SetupGated(mgr, o), "Cannot setup SQL controllers")
default:
log.Info("SafeStart disabled: insufficient CRD watch permissions, using immediate controller setup")
kingpin.FatalIfError(controller.Setup(mgr, o), "Cannot setup SQL controllers")
}

kingpin.FatalIfError(mgr.Start(ctrl.SetupSignalHandler()), "Cannot start controller manager")
}
14 changes: 14 additions & 0 deletions examples/activation-policy-no-cluster-mssql.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
apiVersion: apiextensions.crossplane.io/v1alpha1
kind: ManagedResourceActivationPolicy
metadata:
name: disable-cluster-mssql
spec:
activate:
# Activate all MySQL resources (both cluster and namespaced)
- "*.mysql.sql.crossplane.io"
- "*.mysql.sql.m.crossplane.io"
# Activate all PostgreSQL resources (both cluster and namespaced)
- "*.postgresql.sql.crossplane.io"
- "*.postgresql.sql.m.crossplane.io"
# Activate only namespaced MSSQL resources (cluster-wide MSSQL is excluded)
- "*.mssql.sql.m.crossplane.io"
47 changes: 25 additions & 22 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,19 @@ go 1.24.7
require (
github.com/DATA-DOG/go-sqlmock v1.5.2
github.com/alecthomas/kingpin/v2 v2.4.0
github.com/crossplane/crossplane-runtime/v2 v2.0.0
github.com/crossplane/crossplane-runtime/v2 v2.1.0
github.com/crossplane/crossplane-tools v0.0.0-20250731192036-00d407d8b7ec
github.com/crossplane/upjet/v2 v2.1.0
github.com/denisenkom/go-mssqldb v0.11.0
github.com/go-sql-driver/mysql v1.9.3
github.com/google/go-cmp v0.7.0
github.com/lib/pq v1.10.9
github.com/pkg/errors v0.9.1
k8s.io/api v0.33.0
k8s.io/apimachinery v0.33.0
k8s.io/utils v0.0.0-20250321185631-1f6e0b77f77e
sigs.k8s.io/controller-runtime v0.19.0
k8s.io/api v0.34.0
k8s.io/apiextensions-apiserver v0.34.0
k8s.io/apimachinery v0.34.0
k8s.io/utils v0.0.0-20250604170112-4c0f3b243397
sigs.k8s.io/controller-runtime v0.22.0
sigs.k8s.io/controller-tools v0.18.0
)

Expand All @@ -33,13 +34,13 @@ require (
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/dave/jennifer v1.7.1 // indirect
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
github.com/emicklei/go-restful/v3 v3.12.1 // indirect
github.com/emicklei/go-restful/v3 v3.12.2 // indirect
github.com/evanphx/json-patch v5.9.11+incompatible // indirect
github.com/evanphx/json-patch/v5 v5.9.0 // indirect
github.com/evanphx/json-patch/v5 v5.9.11 // indirect
github.com/fatih/color v1.18.0 // indirect
github.com/fsnotify/fsnotify v1.8.0 // indirect
github.com/fxamacker/cbor/v2 v2.7.0 // indirect
github.com/go-logr/logr v1.4.2 // indirect
github.com/fsnotify/fsnotify v1.9.0 // indirect
github.com/fxamacker/cbor/v2 v2.9.0 // indirect
github.com/go-logr/logr v1.4.3 // indirect
github.com/go-logr/zapr v1.3.0 // indirect
github.com/go-openapi/jsonpointer v0.21.0 // indirect
github.com/go-openapi/jsonreference v0.21.0 // indirect
Expand All @@ -48,7 +49,8 @@ require (
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang-sql/civil v0.0.0-20190719163853-cb61b32ac6fe // indirect
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
github.com/google/gnostic-models v0.6.9 // indirect
github.com/google/btree v1.1.3 // indirect
github.com/google/gnostic-models v0.7.0 // indirect
github.com/google/uuid v1.6.0 // indirect
github.com/hashicorp/hcl/v2 v2.23.0 // indirect
github.com/inconshreveable/mousetrap v1.1.0 // indirect
Expand All @@ -59,8 +61,9 @@ require (
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mitchellh/go-wordwrap v1.0.1 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/prometheus/client_golang v1.22.0 // indirect
github.com/prometheus/client_model v0.6.1 // indirect
github.com/prometheus/common v0.62.0 // indirect
Expand All @@ -77,8 +80,9 @@ require (
go.opentelemetry.io/otel/trace v1.35.0 // indirect
go.uber.org/multierr v1.11.0 // indirect
go.uber.org/zap v1.27.0 // indirect
go.yaml.in/yaml/v2 v2.4.2 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.45.0 // indirect
golang.org/x/exp v0.0.0-20240808152545-0cdaa3abc0fa // indirect
golang.org/x/mod v0.29.0 // indirect
golang.org/x/net v0.47.0 // indirect
golang.org/x/oauth2 v0.29.0 // indirect
Expand All @@ -90,22 +94,21 @@ require (
golang.org/x/tools v0.38.0 // indirect
golang.org/x/tools/go/packages/packagestest v0.1.1-deprecated // indirect
gomodules.xyz/jsonpatch/v2 v2.4.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20250303144028-a0af3efb3deb // indirect
google.golang.org/grpc v1.72.1 // indirect
google.golang.org/protobuf v1.36.6 // indirect
gopkg.in/evanphx/json-patch.v4 v4.12.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/apiextensions-apiserver v0.33.0 // indirect
k8s.io/client-go v0.33.0 // indirect
k8s.io/code-generator v0.33.0 // indirect
k8s.io/component-base v0.33.0 // indirect
k8s.io/gengo/v2 v2.0.0-20250207200755-1244d31929d7 // indirect
k8s.io/client-go v0.34.0 // indirect
k8s.io/code-generator v0.34.0 // indirect
k8s.io/component-base v0.34.0 // indirect
k8s.io/gengo/v2 v2.0.0-20250604051438-85fd79dbfd9f // indirect
k8s.io/klog/v2 v2.130.1 // indirect
k8s.io/kube-openapi v0.0.0-20250318190949-c8a335a9a2ff // indirect
k8s.io/kube-openapi v0.0.0-20250710124328-f3f2b991d03b // indirect
sigs.k8s.io/json v0.0.0-20241014173422-cfa47c3a1cc8 // indirect
sigs.k8s.io/randfill v1.0.0 // indirect
sigs.k8s.io/structured-merge-diff/v4 v4.6.0 // indirect
sigs.k8s.io/yaml v1.4.0 // indirect
sigs.k8s.io/structured-merge-diff/v6 v6.3.0 // indirect
sigs.k8s.io/yaml v1.6.0 // indirect
)
Loading
Loading