Skip to content

fix: Handle shortening cluster names for clusters named by their FQDN. #3758

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

Merged
jenkins-x-bot merged 1 commit into from
May 8, 2019
Merged

fix: Handle shortening cluster names for clusters named by their FQDN. #3758

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
22 changes: 3 additions & 19 deletions pkg/kube/cluster/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ package cluster
import (
"strings"

"github.com/jenkins-x/jx/pkg/kube"
"github.com/pkg/errors"
"k8s.io/client-go/tools/clientcmd/api"

"github.com/jenkins-x/jx/pkg/kube"
)

// Name gets the cluster name from the current context
Expand Down Expand Up @@ -43,24 +44,7 @@ func ShortName(kuber kube.Kuber) (string, error) {
if err != nil {
return "", errors.Wrap(err, "retrieving the cluster name")
}
return ShortClusterName(clusterName), nil
}

// ShortClusterName shrinks the cluster name
func ShortClusterName(clusterName string) string {
return ShortNameN(clusterName, 16)
}

// ShortNameN shrinks the name to a max length
func ShortNameN(clusterName string, maxLen int) string {
shortClusterName := clusterName
if len(clusterName) > maxLen {
shortClusterName = clusterName[0:maxLen]
}
if strings.HasSuffix(shortClusterName, "_") || strings.HasSuffix(shortClusterName, "-") {
shortClusterName = shortClusterName[0 : len(shortClusterName)-1]
}
return shortClusterName
return kube.ToValidNameTruncated(clusterName, 16), nil
}

// SimplifiedClusterName get the simplified cluster name from the long-winded context cluster name that gets generated
Expand Down
13 changes: 10 additions & 3 deletions pkg/kube/cluster/cluster_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
package cluster_test

import (
"github.com/jenkins-x/jx/pkg/kube/vault"
"testing"

"github.com/jenkins-x/jx/pkg/kube/cluster"
kube_test "github.com/jenkins-x/jx/pkg/kube/mocks"
. "github.com/petergtz/pegomock"
"github.com/stretchr/testify/assert"
"k8s.io/client-go/tools/clientcmd/api"

"github.com/jenkins-x/jx/pkg/kube/cluster"
kube_test "github.com/jenkins-x/jx/pkg/kube/mocks"
"github.com/jenkins-x/jx/pkg/kube/vault"
)

func TestGetSimplifiedClusterName(t *testing.T) {
Expand Down Expand Up @@ -41,6 +42,9 @@ func TestShortClusterName(t *testing.T) {
},
}
When(kuber.LoadConfig()).ThenReturn(&config, nil, nil)

clusterName, err = cluster.ShortName(kuber)

assert.NoError(t, err)
assert.Equal(t, "short-cluster-na", clusterName)

Expand All @@ -51,6 +55,9 @@ func TestShortClusterName(t *testing.T) {
},
}
When(kuber.LoadConfig()).ThenReturn(&config, nil, nil)

clusterName, err = cluster.ShortName(kuber)

assert.NoError(t, err)
assert.Equal(t, "short-cluster-na", clusterName)
}
Expand Down
13 changes: 7 additions & 6 deletions pkg/kube/vault/vault.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ import (

"github.com/banzaicloud/bank-vaults/operator/pkg/apis/vault/v1alpha1"
"github.com/banzaicloud/bank-vaults/operator/pkg/client/clientset/versioned"
"github.com/pkg/errors"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"

"github.com/jenkins-x/jx/pkg/kube"
"github.com/jenkins-x/jx/pkg/kube/cluster"
"github.com/jenkins-x/jx/pkg/kube/serviceaccount"
"github.com/jenkins-x/jx/pkg/kube/services"
"github.com/jenkins-x/jx/pkg/vault"
"github.com/pkg/errors"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
)

const (
Expand Down Expand Up @@ -137,9 +138,9 @@ func SystemVaultName(kuber kube.Kuber) (string, error) {

// SystemVaultNameForCluster returns the system vault name from a given cluster name
func SystemVaultNameForCluster(clusterName string) string {
shortClusterName := cluster.ShortClusterName(clusterName)
shortClusterName := kube.ToValidNameTruncated(clusterName, 16)
fullName := fmt.Sprintf("%s-%s", vault.SystemVaultNamePrefix, shortClusterName)
return cluster.ShortNameN(fullName, 22)
return kube.ToValidNameTruncated(fullName, 22)
}

// CreateGKEVault creates a new vault backed by GCP KMS and storage
Expand Down