Register and Manage Control Planes #12

New issue

Closed

opened 2025-03-18 07:26:13 +00:00 by tobru · 1 comment

tobru commented

2025-03-18 07:26:13 +00:00

Owner

Stories

As a portal admin, I want to register and manage control planes so that they’re available for service deployment

As a portal admin, I want to configure system-level service account credentials so that the portal can interact with control planes

See Service Provider Control Planes for more details.

Implementation Notes

CRUD of the control planes can happen in the Django Admin interface
Connection to the Kubernetes API must happen via the Kubernetes Python API Client
When adding a new control plane, verify the connection to the Kubernetes API to make sure the connection works as expected
Store the credentials encrypted in the database (if possible without too much hassle)

## Stories _As a portal admin, I want to register and manage control planes so that they’re available for service deployment_ _As a portal admin, I want to configure system-level service account credentials so that the portal can interact with control planes_ See [Service Provider Control Planes](https://docs.servala.com/control-planes.html) for more details. ## Implementation Notes - CRUD of the control planes can happen in the Django Admin interface - Connection to the Kubernetes API must happen via the [Kubernetes Python API Client](https://github.com/kubernetes-client/python) - When adding a new control plane, verify the connection to the Kubernetes API to make sure the connection works as expected - Store the credentials encrypted in the database (if possible without too much hassle)

tobru added the

enhancement

label 2025-03-18 07:26:13 +00:00

tobru added this to the Servala Portal project 2025-03-18 07:26:13 +00:00

tobru added this to the Servala Portal MVP milestone 2025-03-18 07:26:16 +00:00

tobru commented

2025-03-18 14:54:22 +00:00

Author

Owner

Example Kubeconfig for the dev cluster:

apiVersion: v1
clusters:
  - cluster:
      certificate-authority-data: REDACTED
      server: https://vcluster.127.0.0.1.nip.io:8443
    name: vcluster_controlplane_vcluster_kind-kindev
contexts:
  - context:
      cluster: vcluster_controlplane_vcluster_kind-kindev
      namespace: syn-appcat
      user: appcat-service-cluster
    name: vcluster_controlplane_vcluster_kind-kindev
current-context: vcluster_controlplane_vcluster_kind-kindev
kind: Config
preferences: {}
users:
  - name: appcat-service-cluster
    user:
      token: REDACTED

Important parts to be available in the database to connect to the Kubernetes API:

certificate-authority-data
server
token

https://github.com/kubernetes-client/python/blob/master/examples/remote_cluster.py
-> aConfiguration.verify_ssl = True we want to verify the certificate!

Maybe we could also directly put the Kubeconfig YAML into the database and use

kubeconfig_dict = yaml.safe_load(kubeconfig_content)
client_config = client.Configuration()
config.load_kube_config_from_dict(
    config_dict=kubeconfig_dict,
    client_configuration=client_config
)

Example Kubeconfig for the dev cluster: ``` apiVersion: v1 clusters: - cluster: certificate-authority-data: REDACTED server: https://vcluster.127.0.0.1.nip.io:8443 name: vcluster_controlplane_vcluster_kind-kindev contexts: - context: cluster: vcluster_controlplane_vcluster_kind-kindev namespace: syn-appcat user: appcat-service-cluster name: vcluster_controlplane_vcluster_kind-kindev current-context: vcluster_controlplane_vcluster_kind-kindev kind: Config preferences: {} users: - name: appcat-service-cluster user: token: REDACTED ``` Important parts to be available in the database to connect to the Kubernetes API: - certificate-authority-data - server - token https://github.com/kubernetes-client/python/blob/master/examples/remote_cluster.py -> `aConfiguration.verify_ssl = True` we want to verify the certificate! Maybe we could also directly put the Kubeconfig YAML into the database and use ```Python kubeconfig_dict = yaml.safe_load(kubeconfig_content) client_config = client.Configuration() config.load_kube_config_from_dict( config_dict=kubeconfig_dict, client_configuration=client_config ) ```