Skip to content

fix: operator not starting when watching multi namespace and no permission for one #1779

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.

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 2 commits into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@
import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
import io.fabric8.kubernetes.api.model.rbac.ClusterRole;
import io.fabric8.kubernetes.api.model.rbac.ClusterRoleBinding;
import io.fabric8.kubernetes.api.model.rbac.Role;
import io.fabric8.kubernetes.api.model.rbac.RoleBinding;
import io.fabric8.kubernetes.client.ConfigBuilder;
import io.fabric8.kubernetes.client.KubernetesClient;
import io.fabric8.kubernetes.client.KubernetesClientBuilder;
import io.fabric8.kubernetes.client.utils.KubernetesResourceUtil;
import io.javaoperatorsdk.operator.api.config.ConfigurationServiceProvider;
import io.javaoperatorsdk.operator.health.InformerHealthIndicator;
import io.javaoperatorsdk.operator.junit.LocallyRunOperatorExtension;
import io.javaoperatorsdk.operator.processing.event.source.controller.ControllerResourceEventSource;
import io.javaoperatorsdk.operator.sample.informerrelatedbehavior.ConfigMapDependentResource;
import io.javaoperatorsdk.operator.sample.informerrelatedbehavior.InformerRelatedBehaviorTestCustomResource;
import io.javaoperatorsdk.operator.sample.informerrelatedbehavior.InformerRelatedBehaviorTestReconciler;

Expand All @@ -40,6 +44,7 @@
class InformerRelatedBehaviorITS {

public static final String TEST_RESOURCE_NAME = "test1";
public static final String ADDITIONAL_NAMESPACE_NAME = "additionalns";

KubernetesClient adminClient = new KubernetesClientBuilder().build();
InformerRelatedBehaviorTestReconciler reconciler;
Expand All @@ -54,6 +59,8 @@ void beforeEach(TestInfo testInfo) {
actualNamespace = KubernetesResourceUtil.sanitizeName(method.getName());
adminClient.resource(namespace()).createOrReplace();
});
// cleans up binding before test, not all test cases use cluster role
removeClusterRoleBinding();
}

@AfterEach
Expand Down Expand Up @@ -101,6 +108,51 @@ void startsUpWhenNoPermissionToSecondaryResource() {
assertReconciled();
}

@Test
void startsUpIfNoPermissionToOneOfTwoNamespaces() {
var otherNamespace =
adminClient.resource(namespace(ADDITIONAL_NAMESPACE_NAME)).createOrReplace();
try {
addRoleBindingsToTestNamespaces();
var operator = startOperator(false, false, actualNamespace, ADDITIONAL_NAMESPACE_NAME);
assertInformerNotWatchingForAdditionalNamespace(operator);

adminClient.resource(testCustomResource()).createOrReplace();
waitForWatchReconnect();
assertReconciled();

} finally {
adminClient.resource(otherNamespace).delete();
await().untilAsserted(() -> {
var ns = adminClient.namespaces().resource(otherNamespace).fromServer().get();
assertThat(ns).isNull();
});
}
}

private void assertInformerNotWatchingForAdditionalNamespace(Operator operator) {
assertThat(operator.getRuntimeInfo().allEventSourcesAreHealthy()).isFalse();
var unhealthyEventSources =
operator.getRuntimeInfo().unhealthyInformerWrappingEventSourceHealthIndicator()
.get(INFORMER_RELATED_BEHAVIOR_TEST_RECONCILER);

InformerHealthIndicator controllerHealthIndicator =
(InformerHealthIndicator) unhealthyEventSources
.get(ControllerResourceEventSource.class.getSimpleName())
.informerHealthIndicators().get(ADDITIONAL_NAMESPACE_NAME);
assertThat(controllerHealthIndicator).isNotNull();
assertThat(controllerHealthIndicator.getTargetNamespace()).isEqualTo(ADDITIONAL_NAMESPACE_NAME);
assertThat(controllerHealthIndicator.isWatching()).isFalse();

InformerHealthIndicator configMapHealthIndicator =
(InformerHealthIndicator) unhealthyEventSources
.get(ConfigMapDependentResource.class.getSimpleName())
.informerHealthIndicators().get(ADDITIONAL_NAMESPACE_NAME);
assertThat(configMapHealthIndicator).isNotNull();
assertThat(configMapHealthIndicator.getTargetNamespace()).isEqualTo(ADDITIONAL_NAMESPACE_NAME);
assertThat(configMapHealthIndicator.isWatching()).isFalse();
}

@Test
void resilientForLoosingPermissionForCustomResource() throws InterruptedException {
setFullResourcesAccess();
Expand Down Expand Up @@ -240,7 +292,8 @@ Operator startOperator(boolean stopOnInformerErrorDuringStartup) {
return startOperator(stopOnInformerErrorDuringStartup, true);
}

Operator startOperator(boolean stopOnInformerErrorDuringStartup, boolean addStopHandler) {
Operator startOperator(boolean stopOnInformerErrorDuringStartup, boolean addStopHandler,
String... namespaces) {
ConfigurationServiceProvider.reset();
reconciler = new InformerRelatedBehaviorTestReconciler();

Expand All @@ -252,7 +305,11 @@ Operator startOperator(boolean stopOnInformerErrorDuringStartup, boolean addStop
co.withInformerStoppedHandler((informer, ex) -> replacementStopHandlerCalled = true);
}
});
operator.register(reconciler);
operator.register(reconciler, o -> {
if (namespaces.length > 0) {
o.settingNamespaces(namespaces);
}
});
operator.start();
return operator;
}
Expand All @@ -272,6 +329,16 @@ private void setFullResourcesAccess() {
applyClusterRoleBinding();
}

private void addRoleBindingsToTestNamespaces() {
var role = ReconcilerUtils
.loadYaml(Role.class, this.getClass(), "rback-test-only-main-ns-access.yaml");
adminClient.resource(role).inNamespace(actualNamespace).createOrReplace();
var roleBinding = ReconcilerUtils
.loadYaml(RoleBinding.class, this.getClass(),
"rback-test-only-main-ns-access-binding.yaml");
adminClient.resource(roleBinding).inNamespace(actualNamespace).createOrReplace();
}

private void applyClusterRoleBinding() {
var clusterRoleBinding = ReconcilerUtils
.loadYaml(ClusterRoleBinding.class, this.getClass(), "rback-test-role-binding.yaml");
Expand All @@ -285,10 +352,20 @@ private void applyClusterRole(String filename) {
}

private Namespace namespace() {
return namespace(actualNamespace);
}

private Namespace namespace(String name) {
Namespace n = new Namespace();
n.setMetadata(new ObjectMetaBuilder()
.withName(actualNamespace)
.withName(name)
.build());
return n;
}

private void removeClusterRoleBinding() {
var clusterRoleBinding = ReconcilerUtils
.loadYaml(ClusterRoleBinding.class, this.getClass(), "rback-test-role-binding.yaml");
adminClient.resource(clusterRoleBinding).delete();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: read-namespace-access
subjects:
- kind: User
name: rbac-test-user
apiGroup: rbac.authorization.k8s.io
roleRef:
kind: Role
name: rbac-behavior
apiGroup: rbac.authorization.k8s.io
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: rbac-behavior
rules:
- apiGroups: [ "sample.javaoperatorsdk" ]
resources: [ "informerrelatedbehaviortestcustomresources" ]
verbs: [ "get", "watch", "list","post", "delete" ]
- apiGroups: [ "" ]
resources: [ "configmaps" ]
verbs: [ "get", "watch", "list","post", "delete", "create" ]
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: rbac.authorization.k8s.io/v1
# This cluster role binding allows anyone in the "manager" group to read secrets in any namespace.
kind: ClusterRoleBinding
metadata:
name: read-secrets-global
name: informer-rbac-startup-global
subjects:
- kind: User
name: rbac-test-user
Expand Down