fix: kube deployment char limit by spy16 · Pull Request #110 · raystack/entropy · GitHub
Skip to content

fix: kube deployment char limit #110

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

Closed
spy16 wants to merge 2 commits into from
Closed

fix: kube deployment char limit #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecf98ee
fix: kube deployment char limit
spy16 Mar 2, 2023
d48ba77
feat: add deployment_id feature
spy16 Mar 3, 2023
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
5 changes: 3 additions & 2 deletions .gitignore
View file
Open in desktop
40 changes: 35 additions & 5 deletions modules/firehose/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package firehose

import (
"crypto/sha256"
_ "embed"
"encoding/json"
"fmt"
Expand All @@ -11,7 +12,10 @@ import (
"github.com/odpf/entropy/pkg/helm"
)

const firehoseConsumerIDStartingSequence = "0001"
const (
firehoseConsumerIDStartingSequence = "0001"
kubeDeploymentNameLengthLimit = 63
)

var (
//go:embed schema/config.json
Expand All @@ -34,6 +38,7 @@ type moduleConfig struct {
KafkaTopic string `json:"kafka_topic"`
KafkaConsumerID string `json:"kafka_consumer_id"`
EnvVariables map[string]string `json:"env_variables"`
DeploymentID string `json:"deployment_id,omitempty"`
} `json:"firehose"`
}

Expand All @@ -44,7 +49,8 @@ func (mc *moduleConfig) validateAndSanitize(r resource.Resource) error {
}

if mc.Firehose.KafkaConsumerID == "" {
mc.Firehose.KafkaConsumerID = fmt.Sprintf("%s-%s", generateFirehoseName(r), firehoseConsumerIDStartingSequence)
mc.Firehose.KafkaConsumerID = fmt.Sprintf("%s-%s-%s-%s",
r.Project, r.Name, "-firehose-", firehoseConsumerIDStartingSequence)
}

return nil
Expand All @@ -58,8 +64,13 @@ func (mc *moduleConfig) GetHelmReleaseConfig(r resource.Resource) (*helm.Release
}
defaults := output.Defaults

relName, err := sanitiseDeploymentID(r, *mc)
if err != nil {
return nil, err
}

rc := helm.DefaultReleaseConfig()
rc.Name = generateFirehoseName(r)
rc.Name = relName
rc.Repository = defaults.ChartRepository
rc.Chart = defaults.ChartName
rc.Namespace = defaults.Namespace
Expand Down Expand Up @@ -98,6 +109,25 @@ func (mc *moduleConfig) JSON() []byte {
return b
}

func generateFirehoseName(r resource.Resource) string {
return fmt.Sprintf("%s-%s-firehose", r.Project, r.Name)
func sanitiseDeploymentID(r resource.Resource, mc moduleConfig) (string, error) {
releaseName := mc.Firehose.DeploymentID
if len(releaseName) == 0 {
releaseName = generateSafeReleaseName(r.Project, r.Name)
} else if len(releaseName) >= kubeDeploymentNameLengthLimit {
return "", errors.ErrInvalid.WithMsgf("deployment_id must be shorter than 63 chars")
}
return releaseName, nil
}

func generateSafeReleaseName(project, name string) string {
const suffix = "-firehose"

releaseName := fmt.Sprintf("%s-%s", project, name)
if len(releaseName)+len(suffix) >= kubeDeploymentNameLengthLimit {
val := sha256.Sum256([]byte(releaseName))
hash := fmt.Sprintf("%x", val)
releaseName = fmt.Sprintf("%s-%s", releaseName[:48], hash[:5])
}

return releaseName + suffix
}
4 changes: 2 additions & 2 deletions modules/kubernetes/config_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"client_certificate": {
"type": "string"
},
"client_ca_certificate": {
"cluster_ca_certificate": {
"type": "string"
}
},
Expand Down Expand Up @@ -48,7 +48,7 @@
},
"then": {
"required": [
"client_ca_certificate"
"cluster_ca_certificate"
]
}
}
Expand Down
2 changes: 1 addition & 1 deletion modules/kubernetes/config_schema_test.go
View file
Open in desktop