Skip to content

Commit

Permalink
Add SubNamespace CRD and reconciler
Browse files Browse the repository at this point in the history
  • Loading branch information
ubombar committed Mar 21, 2024
1 parent 24c7875 commit cb53f2e
Show file tree
Hide file tree
Showing 11 changed files with 389 additions and 0 deletions.
9 changes: 9 additions & 0 deletions PROJECT
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,13 @@ resources:
group: labellers
kind: NodeLabeller
version: v1
- api:
crdVersion: v1
namespaced: true
controller: true
domain: edge-net.io
group: multitenancy
kind: SubNamespace
path: github.com/edgenet-project/edgenet/api/multitenancy/v1
version: v1
version: "3"
64 changes: 64 additions & 0 deletions api/multitenancy/v1/subnamespace_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/*
Copyright 2024 Contributors to EdgeNet Project.
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 v1

import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN!
// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.

// SubNamespaceSpec defines the desired state of SubNamespace
type SubNamespaceSpec struct {
// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
// Important: Run "make" to regenerate code after modifying this file

// Foo is an example field of SubNamespace. Edit subnamespace_types.go to remove/update
Foo string `json:"foo,omitempty"`
}

// SubNamespaceStatus defines the observed state of SubNamespace
type SubNamespaceStatus struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "make" to regenerate code after modifying this file
}

//+kubebuilder:object:root=true
//+kubebuilder:subresource:status

// SubNamespace is the Schema for the subnamespaces API
type SubNamespace struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec SubNamespaceSpec `json:"spec,omitempty"`
Status SubNamespaceStatus `json:"status,omitempty"`
}

//+kubebuilder:object:root=true

// SubNamespaceList contains a list of SubNamespace
type SubNamespaceList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []SubNamespace `json:"items"`
}

func init() {
SchemeBuilder.Register(&SubNamespace{}, &SubNamespaceList{})
}
89 changes: 89 additions & 0 deletions api/multitenancy/v1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,13 @@ func main() {
os.Exit(1)
}
}
if err = (&multitenancycontroller.SubNamespaceReconciler{
Client: mgr.GetClient(),
Scheme: mgr.GetScheme(),
}).SetupWithManager(mgr); err != nil {
setupLog.Error(err, "unable to create controller", "controller", "SubNamespace")
os.Exit(1)
}
//+kubebuilder:scaffold:builder

if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
Expand Down
3 changes: 3 additions & 0 deletions config/crd/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,20 @@ resources:
# - edgenet_system_namespace.yaml
- secrets/maxmind_secret.yaml
- bases/multitenancy.edge-net.io_tenants.yaml
- bases/multitenancy.edge-net.io_subnamespaces.yaml
#+kubebuilder:scaffold:crdkustomizeresource

patches:
# [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix.
# patches here are for enabling the conversion webhook for each CRD
#- path: patches/webhook_in_multitenancy_tenants.yaml
#- path: patches/webhook_in_multitenancy_subnamespaces.yaml
#+kubebuilder:scaffold:crdkustomizewebhookpatch

# [CERTMANAGER] To enable cert-manager, uncomment all the sections with [CERTMANAGER] prefix.
# patches here are for enabling the CA injection for each CRD
#- path: patches/cainjection_in_multitenancy_tenants.yaml
#- path: patches/cainjection_in_multitenancy_subnamespaces.yaml
#+kubebuilder:scaffold:crdkustomizecainjectionpatch

# [WEBHOOK] To enable webhook, uncomment the following section
Expand Down
31 changes: 31 additions & 0 deletions config/rbac/multitenancy_subnamespace_editor_role.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# permissions for end users to edit subnamespaces.
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
app.kubernetes.io/name: clusterrole
app.kubernetes.io/instance: subnamespace-editor-role
app.kubernetes.io/component: rbac
app.kubernetes.io/created-by: edgenet
app.kubernetes.io/part-of: edgenet
app.kubernetes.io/managed-by: kustomize
name: subnamespace-editor-role
rules:
- apiGroups:
- multitenancy.edge-net.io
resources:
- subnamespaces
verbs:
- create
- delete
- get
- list
- patch
- update
- watch
- apiGroups:
- multitenancy.edge-net.io
resources:
- subnamespaces/status
verbs:
- get
27 changes: 27 additions & 0 deletions config/rbac/multitenancy_subnamespace_viewer_role.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# permissions for end users to view subnamespaces.
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
labels:
app.kubernetes.io/name: clusterrole
app.kubernetes.io/instance: subnamespace-viewer-role
app.kubernetes.io/component: rbac
app.kubernetes.io/created-by: edgenet
app.kubernetes.io/part-of: edgenet
app.kubernetes.io/managed-by: kustomize
name: subnamespace-viewer-role
rules:
- apiGroups:
- multitenancy.edge-net.io
resources:
- subnamespaces
verbs:
- get
- list
- watch
- apiGroups:
- multitenancy.edge-net.io
resources:
- subnamespaces/status
verbs:
- get
1 change: 1 addition & 0 deletions config/samples/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Append samples of your project ##
resources:
- multitenancy_v1_tenant.yaml
- multitenancy_v1_subnamespace.yaml
#+kubebuilder:scaffold:manifestskustomizesamples
12 changes: 12 additions & 0 deletions config/samples/multitenancy_v1_subnamespace.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
apiVersion: multitenancy.edge-net.io/v1
kind: SubNamespace
metadata:
labels:
app.kubernetes.io/name: subnamespace
app.kubernetes.io/instance: subnamespace-sample
app.kubernetes.io/part-of: edgenet
app.kubernetes.io/managed-by: kustomize
app.kubernetes.io/created-by: edgenet
name: subnamespace-sample
spec:
# TODO(user): Add fields here
62 changes: 62 additions & 0 deletions internal/controller/multitenancy/subnamespace_controller.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
Copyright 2024 Contributors to EdgeNet Project.
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 multitenancy

import (
"context"

"k8s.io/apimachinery/pkg/runtime"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/log"

multitenancyv1 "github.com/edgenet-project/edgenet/api/multitenancy/v1"
)

// SubNamespaceReconciler reconciles a SubNamespace object
type SubNamespaceReconciler struct {
client.Client
Scheme *runtime.Scheme
}

//+kubebuilder:rbac:groups=multitenancy.edge-net.io,resources=subnamespaces,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=multitenancy.edge-net.io,resources=subnamespaces/status,verbs=get;update;patch
//+kubebuilder:rbac:groups=multitenancy.edge-net.io,resources=subnamespaces/finalizers,verbs=update

// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
// TODO(user): Modify the Reconcile function to compare the state specified by
// the SubNamespace object against the actual cluster state, and then
// perform operations to make the cluster state reflect the state specified by
// the user.
//
// For more details, check Reconcile and its Result here:
// - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile
func (r *SubNamespaceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
_ = log.FromContext(ctx)

// TODO(user): your logic here

return ctrl.Result{}, nil
}

// SetupWithManager sets up the controller with the Manager.
func (r *SubNamespaceReconciler) SetupWithManager(mgr ctrl.Manager) error {
return ctrl.NewControllerManagedBy(mgr).
For(&multitenancyv1.SubNamespace{}).
Complete(r)
}
Loading

0 comments on commit cb53f2e

Please sign in to comment.