[WIP] Improve kubernetes object names

Resolves #105 Signed-off-by: James Taylor <[email protected]>
hyperledger-labs · Apr 22, 2024 · 0b2171c · 0b2171c
1 parent fdc5486
commit 0b2171c
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 20 deletions.
diff --git a/cmd/run/main.go b/cmd/run/main.go
@@ -57,13 +57,17 @@ func main() {
 	kubeServiceAccount := util.GetOptionalEnv(util.ChaincodeServiceAccountVariable, "default")
 	logger.Debugf("%s=%s", util.ChaincodeServiceAccountVariable, kubeServiceAccount)
 
+	kubeNamePrefix := util.GetOptionalEnv(util.ObjectNamePrefixVariable, "cc")
+	logger.Debugf("%s=%s", util.ObjectNamePrefixVariable, kubeNamePrefix)
+
 	run := &builder.Run{
 		BuildOutputDirectory: buildOutputDirectory,
 		RunMetadataDirectory: runMetadataDirectory,
 		PeerID:               peerID,
 		KubeconfigPath:       kubeconfigPath,
 		KubeNamespace:        kubeNamespace,
 		KubeServiceAccount:   kubeServiceAccount,
+		KubeNamePrefix:       kubeNamePrefix,
 	}
 
 	if err := run.Run(ctx); err != nil {

diff --git a/internal/builder/run.go b/internal/builder/run.go
@@ -17,6 +17,7 @@ type Run struct {
 	KubeconfigPath       string
 	KubeNamespace        string
 	KubeServiceAccount   string
+	KubeNamePrefix       string
 }
 
 func (r *Run) Run(ctx context.Context) error {
@@ -33,6 +34,10 @@ func (r *Run) Run(ctx context.Context) error {
 		return err
 	}
 
+	kubeObjectName := util.GetValidRfc1035LabelName(r.KubeNamePrefix, chaincodeData.MspID, r.PeerID, chaincodeData.ChaincodeID)
+
+	// TODO create a common set of labels here and pass them in where required?
+
 	clientset, err := util.GetKubeClientset(logger, r.KubeconfigPath)
 	if err != nil {
 		return fmt.Errorf(
@@ -48,6 +53,7 @@ func (r *Run) Run(ctx context.Context) error {
 		ctx,
 		logger,
 		secretsClient,
+		kubeObjectName,
 		r.KubeNamespace,
 		r.PeerID,
 		chaincodeData,
@@ -66,6 +72,7 @@ func (r *Run) Run(ctx context.Context) error {
 		ctx,
 		logger,
 		podsClient,
+		kubeObjectName,
 		r.KubeNamespace,
 		r.KubeServiceAccount,
 		r.PeerID,

diff --git a/internal/util/env.go b/internal/util/env.go
@@ -10,6 +10,7 @@ import (
 const (
 	builderVariablePrefix           = "FABRIC_K8S_BUILDER_"
 	ChaincodeNamespaceVariable      = builderVariablePrefix + "NAMESPACE"
+	ObjectNamePrefixVariable        = builderVariablePrefix + "OBJECT_NAME_PREFIX"
 	ChaincodeServiceAccountVariable = builderVariablePrefix + "SERVICE_ACCOUNT"
 	DebugVariable                   = builderVariablePrefix + "DEBUG"
 	KubeconfigPathVariable          = "KUBECONFIG_PATH"

diff --git a/internal/util/fabric.go b/internal/util/fabric.go
@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: Apache-2.0
+
+package util
+
+// GetChaincodeLabel returns the label portion of a chaincode ID.
+func GetChaincodeLabel(chaincode_id string) string {
+	// TODO split the label out of the chaincode ID
+	return ""
+}
diff --git a/internal/util/k8s.go b/internal/util/k8s.go
@@ -231,6 +231,7 @@ func getChaincodePodObject(
 		ObjectMeta: metav1.ObjectMeta{
 			Name:      podName,
 			Namespace: namespace,
+			// TODO: pass in labels?
 			Labels: map[string]string{
 				"app.kubernetes.io/name":       "fabric",
 				"app.kubernetes.io/component":  "chaincode",
@@ -302,11 +303,7 @@ func getChaincodePodObject(
 					Name: "certs",
 					VolumeSource: apiv1.VolumeSource{
 						Secret: &apiv1.SecretVolumeSource{
-							SecretName: GetValidName(
-								chaincodeData.MspID,
-								peerID,
-								chaincodeData.ChaincodeID,
-							),
+							SecretName: podName,
 						},
 					},
 				},
@@ -316,11 +313,9 @@ func getChaincodePodObject(
 }
 
 func getChaincodeSecretApplyConfiguration(
-	namespace, peerID string,
+	secretName, namespace, peerID string,
 	chaincodeData *ChaincodeJSON,
 ) *applycorev1.SecretApplyConfiguration {
-	name := GetValidName(chaincodeData.MspID, peerID, chaincodeData.ChaincodeID)
-
 	annotations := map[string]string{
 		"fabric-builder-k8s-ccid": chaincodeData.ChaincodeID,
 	}
@@ -333,6 +328,7 @@ func getChaincodeSecretApplyConfiguration(
 		"client.key":     base64.StdEncoding.EncodeToString([]byte(chaincodeData.ClientKey)),
 	}
 
+	// TODO: pass in labels?
 	labels := map[string]string{
 		"app.kubernetes.io/name":       "fabric",
 		"app.kubernetes.io/component":  "chaincode",
@@ -343,7 +339,7 @@ func getChaincodeSecretApplyConfiguration(
 	}
 
 	return applycorev1.
-		Secret(name, namespace).
+		Secret(secretName, namespace).
 		WithAnnotations(annotations).
 		WithLabels(labels).
 		WithStringData(data).
@@ -354,10 +350,10 @@ func ApplyChaincodeSecrets(
 	ctx context.Context,
 	logger *log.CmdLogger,
 	secretsClient v1.SecretInterface,
-	namespace, peerID string,
+	secretName, namespace, peerID string,
 	chaincodeData *ChaincodeJSON,
 ) error {
-	secret := getChaincodeSecretApplyConfiguration(namespace, peerID, chaincodeData)
+	secret := getChaincodeSecretApplyConfiguration(secretName, namespace, peerID, chaincodeData)
 
 	result, err := secretsClient.Apply(
 		ctx,
@@ -434,26 +430,25 @@ func CreateChaincodePod(
 	ctx context.Context,
 	logger *log.CmdLogger,
 	podsClient v1.PodInterface,
-	namespace, serviceAccount, peerID string,
+	objectName, namespace, serviceAccount, peerID string,
 	chaincodeData *ChaincodeJSON,
 	imageData *ImageJSON,
 ) (*apiv1.Pod, error) {
-	podName := GetValidName(chaincodeData.MspID, peerID, chaincodeData.ChaincodeID)
 	podDefinition := getChaincodePodObject(
 		imageData,
 		namespace,
 		serviceAccount,
-		podName,
+		objectName,
 		peerID,
 		chaincodeData,
 	)
 
-	err := deleteChaincodePod(ctx, logger, podsClient, podName, namespace, chaincodeData)
+	err := deleteChaincodePod(ctx, logger, podsClient, objectName, namespace, chaincodeData)
 	if err != nil {
 		return nil, fmt.Errorf(
 			"unable to delete existing chaincode pod %s/%s for chaincode ID %s: %w",
 			namespace,
-			podName,
+			objectName,
 			chaincodeData.ChaincodeID,
 			err,
 		)
@@ -463,15 +458,15 @@ func CreateChaincodePod(
 		"Creating chaincode pod for chaincode ID %s: %s/%s",
 		chaincodeData.ChaincodeID,
 		namespace,
-		podName,
+		objectName,
 	)
 
 	pod, err := podsClient.Create(ctx, podDefinition, metav1.CreateOptions{})
 	if err != nil {
 		return nil, fmt.Errorf(
 			"unable to create chaincode pod %s/%s for chaincode ID %s: %w",
 			namespace,
-			podName,
+			objectName,
 			chaincodeData.ChaincodeID,
 			err,
 		)
@@ -487,8 +482,10 @@ func CreateChaincodePod(
 	return pod, nil
 }
 
-// GetValidName returns a valid RFC 1035 label name.
-func GetValidName(mspID, peerID, chaincodeID string) string {
+// GetValidRfc1035LabelName returns a valid RFC 1035 label name.
+func GetValidRfc1035LabelName(prefix, mspID, peerID, chaincodeID string) string {
+	// TODO update name to be...
+	// <prefix>-<truncated_chaincode_label>-<chaincode_run_hash>
 	qualifiedChaincodeID := mspID + ":" + peerID + ":" + chaincodeID
 	h := sha256.New()
 	h.Write([]byte(qualifiedChaincodeID))