| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062 |
- package porter_app
- import (
- "context"
- "fmt"
- "strconv"
- "strings"
- "github.com/porter-dev/porter/api/server/shared/config"
- "github.com/porter-dev/porter/api/types"
- porterAppUtils "github.com/porter-dev/porter/api/utils/porter_app"
- "github.com/porter-dev/porter/internal/helm/loader"
- "github.com/porter-dev/porter/internal/integrations/dns"
- "github.com/porter-dev/porter/internal/kubernetes"
- "github.com/porter-dev/porter/internal/kubernetes/domain"
- "github.com/porter-dev/porter/internal/kubernetes/environment_groups"
- "github.com/porter-dev/porter/internal/kubernetes/porter_app"
- "github.com/porter-dev/porter/internal/repository"
- "github.com/porter-dev/porter/internal/telemetry"
- "github.com/porter-dev/porter/internal/templater/utils"
- "github.com/stefanmcshane/helm/pkg/chart"
- "gopkg.in/yaml.v2"
- )
- type PorterStackYAML struct {
- Applications map[string]*Application `yaml:"applications" validate:"required_without=Services Apps"`
- Version *string `yaml:"version"`
- Build *Build `yaml:"build"`
- Env map[string]string `yaml:"env"`
- SyncedEnv []*SyncedEnvSection `yaml:"synced_env"`
- Apps map[string]*Service `yaml:"apps" validate:"required_without=Applications Services"`
- Services map[string]*Service `yaml:"services" validate:"required_without=Applications Apps"`
- Release *Service `yaml:"release"`
- }
- type Application struct {
- Services map[string]*Service `yaml:"services" validate:"required"`
- Build *Build `yaml:"build"`
- Env map[string]string `yaml:"env"`
- Release *Service `yaml:"release"`
- }
- type Build struct {
- Context *string `yaml:"context" validate:"dir"`
- Method *string `yaml:"method" validate:"required,oneof=pack docker registry"`
- Builder *string `yaml:"builder" validate:"required_if=Method pack"`
- Buildpacks []*string `yaml:"buildpacks"`
- Dockerfile *string `yaml:"dockerfile" validate:"required_if=Method docker"`
- Image *string `yaml:"image" validate:"required_if=Method registry"`
- }
- type Service struct {
- Run *string `yaml:"run"`
- Config map[string]interface{} `yaml:"config"`
- Type *string `yaml:"type" validate:"required, oneof=web worker job"`
- }
- type SyncedEnvSection struct {
- Name string `json:"name" yaml:"name"`
- Version uint `json:"version" yaml:"version"`
- Keys []SyncedEnvSectionKey `json:"keys" yaml:"keys"`
- }
- type SyncedEnvSectionKey struct {
- Name string `json:"name" yaml:"name"`
- Secret bool `json:"secret" yaml:"secret"`
- }
- type SubdomainCreateOpts struct {
- k8sAgent *kubernetes.Agent
- dnsRepo repository.DNSRecordRepository
- dnsClient *dns.Client
- appRootDomain string
- stackName string
- }
- type ParseConf struct {
- // PorterAppName is the name of the porter app
- PorterAppName string
- // PorterYaml is the raw porter yaml which is used to build the values + chart for helm upgrade
- PorterYaml []byte
- // ImageInfo contains the repository and tag of the image to use for the helm upgrade. Kept separate from the PorterYaml because the image info
- // is stored in the 'global' key of the values, which is not part of the porter yaml
- ImageInfo types.ImageInfo
- // ServerConfig is the server conf, used to find the default helm repo
- ServerConfig *config.Config
- // ProjectID
- ProjectID uint
- // UserUpdate used for synced env groups
- UserUpdate bool
- // EnvGroups used for synced env groups
- EnvGroups []string
- // EnvironmentGroups are used for syncing environment groups using ConfigMaps and Secrets from porter-env-groups namespace. This should be used instead of EnvGroups
- EnvironmentGroups []string
- // Namespace used for synced env groups
- Namespace string
- // ExistingHelmValues is the existing values for the helm release, if it exists
- ExistingHelmValues map[string]interface{}
- // ExistingChartDependencies is the existing dependencies for the helm release, if it exists
- ExistingChartDependencies []*chart.Dependency
- // SubdomainCreateOpts contains the necessary information to create a subdomain if necessary
- SubdomainCreateOpts SubdomainCreateOpts
- // InjectLauncherToStartCommand is a flag to determine whether to prepend the launcher to the start command
- InjectLauncherToStartCommand bool
- // ShouldValidateHelmValues is a flag to determine whether to validate helm values
- ShouldValidateHelmValues bool
- // FullHelmValues if provided, override anything specified in porter.yaml. Used as an escape hatch for support
- FullHelmValues string
- // AddCustomNodeSelector is a flag to determine whether to add porter.run/workload-kind: application to the nodeselector attribute of the helm values
- AddCustomNodeSelector bool
- // RemoveDeletedServices is a flag to determine whether to remove values and dependencies for services that are not defined in the porter.yaml
- RemoveDeletedServices bool
- }
- func parse(ctx context.Context, conf ParseConf) (*chart.Chart, map[string]interface{}, map[string]interface{}, error) {
- ctx, span := telemetry.NewSpan(ctx, "parse-porter-yaml")
- defer span.End()
- parsed := &PorterStackYAML{}
- if conf.FullHelmValues != "" {
- parsedHelmValues, err := convertHelmValuesToPorterYaml(conf.FullHelmValues)
- if err != nil {
- err = telemetry.Error(ctx, span, err, "error parsing raw helm values")
- return nil, nil, nil, err
- }
- parsed = parsedHelmValues
- } else {
- err := yaml.Unmarshal(conf.PorterYaml, parsed)
- if err != nil {
- err = telemetry.Error(ctx, span, err, "error parsing porter.yaml")
- return nil, nil, nil, err
- }
- }
- synced_env := make([]*SyncedEnvSection, 0)
- for i := range conf.EnvGroups {
- cm, _, err := conf.SubdomainCreateOpts.k8sAgent.GetLatestVersionedConfigMap(conf.EnvGroups[i], conf.Namespace)
- if err != nil {
- err = telemetry.Error(ctx, span, err, "error getting latest versioned config map")
- return nil, nil, nil, err
- }
- versionStr, ok := cm.ObjectMeta.Labels["version"]
- if !ok {
- err = telemetry.Error(ctx, span, nil, "error extracting version from config map")
- return nil, nil, nil, err
- }
- versionInt, err := strconv.Atoi(versionStr)
- if err != nil {
- err = telemetry.Error(ctx, span, err, "error converting version to int")
- return nil, nil, nil, err
- }
- version := uint(versionInt)
- newSection := &SyncedEnvSection{
- Name: conf.EnvGroups[i],
- Version: version,
- }
- newSectionKeys := make([]SyncedEnvSectionKey, 0)
- for key, val := range cm.Data {
- newSectionKeys = append(newSectionKeys, SyncedEnvSectionKey{
- Name: key,
- Secret: strings.Contains(val, "PORTERSECRET"),
- })
- }
- newSection.Keys = newSectionKeys
- synced_env = append(synced_env, newSection)
- }
- if parsed.Apps != nil && parsed.Services != nil {
- err := telemetry.Error(ctx, span, nil, "'apps' and 'services' are synonymous but both were defined")
- return nil, nil, nil, err
- }
- var services map[string]*Service
- if parsed.Apps != nil {
- services = parsed.Apps
- }
- if parsed.Services != nil {
- services = parsed.Services
- }
- for serviceName := range services {
- services[serviceName] = addLabelsToService(services[serviceName], conf.EnvironmentGroups, porter_app.LabelKey_PorterApplication)
- }
- application := &Application{
- Env: parsed.Env,
- Services: services,
- Build: parsed.Build,
- Release: parsed.Release,
- }
- values, err := buildUmbrellaChartValues(ctx, application, synced_env, conf.ImageInfo, conf.ExistingHelmValues, conf.SubdomainCreateOpts, conf.InjectLauncherToStartCommand, conf.ShouldValidateHelmValues, conf.UserUpdate, conf.Namespace, conf.AddCustomNodeSelector, conf.RemoveDeletedServices)
- if err != nil {
- err = telemetry.Error(ctx, span, err, "error building values")
- return nil, nil, nil, err
- }
- convertedValues, ok := convertMap(values).(map[string]interface{})
- if !ok {
- err = telemetry.Error(ctx, span, nil, "error converting values")
- return nil, nil, nil, err
- }
- umbrellaChart, err := buildUmbrellaChart(application, conf.ServerConfig, conf.ProjectID, conf.ExistingChartDependencies, conf.RemoveDeletedServices)
- if err != nil {
- err = telemetry.Error(ctx, span, err, "error building umbrella chart")
- return nil, nil, nil, err
- }
- // return the parsed release values for the release job chart, if they exist
- var preDeployJobValues map[string]interface{}
- if application.Release != nil && application.Release.Run != nil {
- application.Release = addLabelsToService(application.Release, conf.EnvironmentGroups, porter_app.LabelKey_PorterApplicationPreDeploy)
- preDeployJobValues = buildPreDeployJobChartValues(application.Release, application.Env, synced_env, conf.ImageInfo, conf.InjectLauncherToStartCommand, conf.ExistingHelmValues, porterAppUtils.PredeployJobNameFromPorterAppName(conf.PorterAppName), conf.UserUpdate, conf.AddCustomNodeSelector)
- }
- return umbrellaChart, convertedValues, preDeployJobValues, nil
- }
- func buildUmbrellaChartValues(
- ctx context.Context,
- application *Application,
- syncedEnv []*SyncedEnvSection,
- imageInfo types.ImageInfo,
- existingValues map[string]interface{},
- opts SubdomainCreateOpts,
- injectLauncher bool,
- shouldValidateHelmValues bool,
- userUpdate bool,
- namespace string,
- addCustomNodeSelector bool,
- removeDeletedValues bool,
- ) (map[string]interface{}, error) {
- values := make(map[string]interface{})
- if application.Services == nil {
- if existingValues == nil {
- return nil, fmt.Errorf("porter.yaml must contain at least one service, or pre-deploy must exist and have values")
- }
- }
- for name, service := range application.Services {
- serviceType := getType(name, service)
- defaultValues := getDefaultValues(service, application.Env, syncedEnv, serviceType, existingValues, name, userUpdate, addCustomNodeSelector)
- convertedConfig := convertMap(service.Config).(map[string]interface{})
- helm_values := utils.DeepCoalesceValues(defaultValues, convertedConfig)
- // required to identify the chart type because of https://github.com/helm/helm/issues/9214
- helmName := getHelmName(name, serviceType)
- if existingValues != nil {
- if existingValues[helmName] != nil {
- existingValuesMap := existingValues[helmName].(map[string]interface{})
- if removeDeletedValues {
- // strip the env variables before coalescing
- if existingValuesMap["container"] != nil {
- containerMap := existingValuesMap["container"].(map[string]interface{})
- if containerMap["env"] != nil {
- envMap := containerMap["env"].(map[string]interface{})
- if envMap["normal"] != nil {
- envMap["normal"] = make(map[string]interface{})
- }
- if envMap["synced"] != nil {
- envMap["synced"] = make([]map[string]interface{}, 0)
- }
- containerMap["env"] = envMap
- }
- existingValuesMap["container"] = containerMap
- }
- }
- helm_values = utils.DeepCoalesceValues(existingValuesMap, helm_values)
- }
- }
- validateErr := validateHelmValues(helm_values, shouldValidateHelmValues, serviceType)
- if validateErr != "" {
- return nil, fmt.Errorf("error validating service \"%s\": %s", name, validateErr)
- }
- err := syncEnvironmentGroupToNamespaceIfLabelsExist(ctx, opts.k8sAgent, service, namespace)
- if err != nil {
- return nil, fmt.Errorf("error syncing environment group to namespace: %w", err)
- }
- err = createSubdomainIfRequired(helm_values, opts) // modifies helm_values to add subdomains if necessary
- if err != nil {
- return nil, err
- }
- // just in case this slips by
- if serviceType == "web" {
- if helm_values["ingress"] == nil {
- helm_values["ingress"] = map[string]interface{}{
- "enabled": false,
- }
- }
- }
- values[helmName] = helm_values
- }
- if !removeDeletedValues {
- // add back in the existing services that were not overwritten
- for k, v := range existingValues {
- if values[k] == nil {
- values[k] = v
- }
- }
- }
- // prepend launcher to all start commands if we need to
- for _, v := range values {
- if serviceValues, ok := v.(map[string]interface{}); ok {
- if serviceValues["container"] != nil {
- containerMap := serviceValues["container"].(map[string]interface{})
- if containerMap["command"] != nil {
- command := containerMap["command"].(string)
- if injectLauncher && !strings.HasPrefix(command, "launcher") && !strings.HasPrefix(command, "/cnb/lifecycle/launcher") {
- containerMap["command"] = fmt.Sprintf("/cnb/lifecycle/launcher %s", command)
- }
- }
- }
- }
- }
- values["global"] = map[string]interface{}{
- "image": map[string]interface{}{
- "repository": imageInfo.Repository,
- "tag": imageInfo.Tag,
- },
- }
- return values, nil
- }
- // syncEnvironmentGroupToNamespaceIfLabelsExist will sync the latest version of the environment group to the target namespace if the service has the appropriate label.
- func syncEnvironmentGroupToNamespaceIfLabelsExist(ctx context.Context, agent *kubernetes.Agent, service *Service, targetNamespace string) error {
- var linkedGroupNames string
- // patchwork because we are not consistent with the type of labels
- if labels, ok := service.Config["labels"].(map[string]any); ok {
- if linkedGroup, ok := labels[environment_groups.LabelKey_LinkedEnvironmentGroup].(string); ok {
- linkedGroupNames = linkedGroup
- }
- }
- if labels, ok := service.Config["labels"].(map[string]string); ok {
- if linkedGroup, ok := labels[environment_groups.LabelKey_LinkedEnvironmentGroup]; ok {
- linkedGroupNames = linkedGroup
- }
- }
- service.Config["configMapRefs"] = []string{}
- service.Config["secretRefs"] = []string{}
- for _, linkedGroupName := range strings.Split(linkedGroupNames, ".") {
- inp := environment_groups.SyncLatestVersionToNamespaceInput{
- BaseEnvironmentGroupName: linkedGroupName,
- TargetNamespace: targetNamespace,
- }
- syncedEnvironment, err := environment_groups.SyncLatestVersionToNamespace(ctx, agent, inp, nil)
- if err != nil {
- return fmt.Errorf("error syncing environment group: %w", err)
- }
- if syncedEnvironment.EnvironmentGroupVersionedName != "" {
- if service.Config["configMapRefs"] == nil {
- service.Config["configMapRefs"] = []string{}
- }
- if service.Config["secretRefs"] == nil {
- service.Config["secretRefs"] = []string{}
- }
- switch service.Config["configMapRefs"].(type) {
- case []string:
- service.Config["configMapRefs"] = append(service.Config["configMapRefs"].([]string), syncedEnvironment.EnvironmentGroupVersionedName)
- case []any:
- service.Config["configMapRefs"] = append(service.Config["configMapRefs"].([]any), syncedEnvironment.EnvironmentGroupVersionedName)
- }
- switch service.Config["secretRefs"].(type) {
- case []string:
- service.Config["secretRefs"] = append(service.Config["secretRefs"].([]string), syncedEnvironment.EnvironmentGroupVersionedName)
- case []any:
- service.Config["secretRefs"] = append(service.Config["secretRefs"].([]any), syncedEnvironment.EnvironmentGroupVersionedName)
- }
- }
- }
- return nil
- }
- // we can add to this function up later or use an alternative
- func validateHelmValues(values map[string]interface{}, shouldValidateHelmValues bool, appType string) string {
- if shouldValidateHelmValues {
- // validate port for web services
- if appType == "web" {
- containerMap, err := getNestedMap(values, "container")
- if err != nil {
- return "error checking port: misformatted values"
- } else {
- portVal, portExists := containerMap["port"]
- if portExists {
- portStr, pOK := portVal.(string)
- if !pOK {
- return "error checking port: no port in container"
- }
- port, err := strconv.Atoi(portStr)
- if err != nil || port < 1024 || port > 65535 {
- return "port must be a number between 1024 and 65535"
- }
- } else {
- return "port must be specified for web services"
- }
- }
- }
- }
- return ""
- }
- func buildPreDeployJobChartValues(release *Service, env map[string]string, synced_env []*SyncedEnvSection, imageInfo types.ImageInfo, injectLauncher bool, existingValues map[string]interface{}, name string, userUpdate bool, addCustomNodeSelector bool) map[string]interface{} {
- defaultValues := getDefaultValues(release, env, synced_env, "job", existingValues, name+"-r", userUpdate, addCustomNodeSelector)
- convertedConfig := convertMap(release.Config).(map[string]interface{})
- helm_values := utils.DeepCoalesceValues(defaultValues, convertedConfig)
- if imageInfo.Repository != "" && imageInfo.Tag != "" {
- helm_values["image"] = map[string]interface{}{
- "repository": imageInfo.Repository,
- "tag": imageInfo.Tag,
- }
- }
- // prepend launcher if we need to
- if helm_values["container"] != nil {
- containerMap := helm_values["container"].(map[string]interface{})
- if containerMap["command"] != nil {
- command := containerMap["command"].(string)
- if injectLauncher && !strings.HasPrefix(command, "launcher") && !strings.HasPrefix(command, "/cnb/lifecycle/launcher") {
- containerMap["command"] = fmt.Sprintf("/cnb/lifecycle/launcher %s", command)
- }
- }
- }
- return helm_values
- }
- func getType(name string, service *Service) string {
- if service.Type != nil {
- return *service.Type
- }
- if strings.Contains(name, "web") {
- return "web"
- }
- if strings.Contains(name, "job") {
- return "job"
- }
- return "worker"
- }
- func getDefaultValues(service *Service, env map[string]string, synced_env []*SyncedEnvSection, appType string, existingValues map[string]interface{}, name string, userUpdate bool, addCustomNodeSelector bool) map[string]interface{} {
- var defaultValues map[string]interface{}
- var runCommand string
- if service.Run != nil {
- runCommand = *service.Run
- }
- var syncedEnvs []map[string]interface{}
- envConf, err := getStacksNestedMap(existingValues, name+"-"+appType, "container", "env")
- if !userUpdate && err == nil {
- syncedEnvs = envConf
- } else {
- syncedEnvs = deconstructSyncedEnvs(synced_env, env)
- }
- defaultValues = map[string]interface{}{
- "container": map[string]interface{}{
- "command": runCommand,
- "env": map[string]interface{}{
- "normal": CopyEnv(env),
- "synced": syncedEnvs,
- },
- },
- "nodeSelector": map[string]interface{}{},
- }
- if addCustomNodeSelector {
- defaultValues["nodeSelector"] = map[string]interface{}{
- "porter.run/workload-kind": "application",
- }
- }
- return defaultValues
- }
- func deconstructSyncedEnvs(synced_env []*SyncedEnvSection, env map[string]string) []map[string]interface{} {
- synced := make([]map[string]interface{}, 0)
- for _, group := range synced_env {
- keys := make([]map[string]interface{}, 0)
- for _, key := range group.Keys {
- if _, exists := env[key.Name]; !exists {
- // Only include keys not present in env
- keys = append(keys, map[string]interface{}{
- "name": key.Name,
- "secret": key.Secret,
- })
- }
- }
- syncedGroup := map[string]interface{}{
- "keys": keys,
- "name": group.Name,
- "version": group.Version,
- }
- synced = append(synced, syncedGroup)
- }
- return synced
- }
- func buildUmbrellaChart(application *Application, config *config.Config, projectID uint, existingDependencies []*chart.Dependency, removeDeletedDependencies bool) (*chart.Chart, error) {
- deps := make([]*chart.Dependency, 0)
- for alias, service := range application.Services {
- var serviceType string
- if existingDependencies != nil {
- for _, dep := range existingDependencies {
- // this condition checks that the dependency is of the form <alias>-web or <alias>-wkr or <alias>-job, meaning it already exists in the chart
- if strings.HasPrefix(dep.Alias, fmt.Sprintf("%s-", alias)) && (strings.HasSuffix(dep.Alias, "-web") || strings.HasSuffix(dep.Alias, "-wkr") || strings.HasSuffix(dep.Alias, "-job")) {
- serviceType = getChartTypeFromHelmName(dep.Alias)
- if serviceType == "" {
- return nil, fmt.Errorf("unable to determine type of existing dependency")
- }
- }
- }
- // this is a new app, so we need to get the type from the app name or type
- if serviceType == "" {
- serviceType = getType(alias, service)
- }
- } else {
- serviceType = getType(alias, service)
- }
- selectedRepo := config.ServerConf.DefaultApplicationHelmRepoURL
- selectedVersion, err := getLatestTemplateVersion(serviceType, config, projectID)
- if err != nil {
- return nil, err
- }
- helmName := getHelmName(alias, serviceType)
- deps = append(deps, &chart.Dependency{
- Name: serviceType,
- Alias: helmName,
- Version: selectedVersion,
- Repository: selectedRepo,
- })
- }
- if !removeDeletedDependencies {
- // add in the existing dependencies that were not overwritten
- for _, dep := range existingDependencies {
- if !dependencyExists(deps, dep) {
- // have to repair the dependency name because of https://github.com/helm/helm/issues/9214
- if strings.HasSuffix(dep.Name, "-web") || strings.HasSuffix(dep.Name, "-wkr") || strings.HasSuffix(dep.Name, "-job") {
- dep.Name = getChartTypeFromHelmName(dep.Name)
- if dep.Name == "" {
- return nil, fmt.Errorf("unable to determine type of existing dependency")
- }
- version, err := getLatestTemplateVersion(dep.Name, config, projectID)
- if err != nil {
- return nil, err
- }
- dep.Version = version
- }
- deps = append(deps, dep)
- }
- }
- }
- chart, err := createChartFromDependencies(deps)
- if err != nil {
- return nil, err
- }
- return chart, nil
- }
- func dependencyExists(deps []*chart.Dependency, dep *chart.Dependency) bool {
- for _, d := range deps {
- if d.Alias == dep.Alias {
- return true
- }
- }
- return false
- }
- func createChartFromDependencies(deps []*chart.Dependency) (*chart.Chart, error) {
- metadata := &chart.Metadata{
- Name: "umbrella",
- Description: "Web application that is exposed to external traffic.",
- Version: "0.96.0",
- APIVersion: "v2",
- Home: "https://getporter.dev/",
- Icon: "https://user-images.githubusercontent.com/65516095/111255214-07d3da80-85ed-11eb-99e2-fddcbdb99bdb.png",
- Keywords: []string{
- "porter",
- "application",
- "service",
- "umbrella",
- },
- Type: "application",
- Dependencies: deps,
- }
- // create a new chart object with the metadata
- c := &chart.Chart{
- Metadata: metadata,
- }
- return c, nil
- }
- func getLatestTemplateVersion(templateName string, config *config.Config, projectID uint) (string, error) {
- repoIndex, err := loader.LoadRepoIndexPublic(config.ServerConf.DefaultApplicationHelmRepoURL)
- if err != nil {
- return "", fmt.Errorf("%s: %w", "unable to load porter chart repo", err)
- }
- templates := loader.RepoIndexToPorterChartList(repoIndex, config.ServerConf.DefaultApplicationHelmRepoURL)
- if err != nil {
- return "", fmt.Errorf("%s: %w", "unable to load porter chart list", err)
- }
- var version string
- // find the matching template name
- for _, template := range templates {
- if templateName == template.Name {
- version = template.Versions[0]
- break
- }
- }
- if version == "" {
- return "", fmt.Errorf("matching template version not found")
- }
- return version, nil
- }
- func convertMap(m interface{}) interface{} {
- switch m := m.(type) {
- case map[string]interface{}:
- for k, v := range m {
- m[k] = convertMap(v)
- }
- case map[string]string:
- result := map[string]interface{}{}
- for k, v := range m {
- result[k] = v
- }
- return result
- case map[interface{}]interface{}:
- result := map[string]interface{}{}
- for k, v := range m {
- result[k.(string)] = convertMap(v)
- }
- return result
- case []interface{}:
- for i, v := range m {
- m[i] = convertMap(v)
- }
- }
- return m
- }
- func CopyEnv(env map[string]string) map[string]interface{} {
- envCopy := make(map[string]interface{})
- if env == nil {
- return envCopy
- }
- for k, v := range env {
- if k == "" || v == "" {
- continue
- }
- envCopy[k] = v
- }
- return envCopy
- }
- func createSubdomainIfRequired(
- mergedValues map[string]interface{},
- opts SubdomainCreateOpts,
- ) error {
- // look for ingress.enabled and no custom domains set
- ingressMap, err := getNestedMap(mergedValues, "ingress")
- if err == nil {
- enabledVal, enabledExists := ingressMap["enabled"]
- if enabledExists {
- enabled, eOK := enabledVal.(bool)
- if eOK && enabled {
- // if custom domain, we don't need to create a subdomain
- customDomVal, customDomExists := ingressMap["custom_domain"]
- if customDomExists {
- customDomain, cOK := customDomVal.(bool)
- if cOK && customDomain {
- return nil
- }
- }
- // subdomain already exists, no need to create one
- if porterHosts, ok := ingressMap["porter_hosts"].([]interface{}); ok && len(porterHosts) > 0 {
- return nil
- }
- // in the case of ingress enabled but no custom domain, create subdomain
- dnsRecord, err := createDNSRecord(opts)
- if err != nil {
- return fmt.Errorf("error creating subdomain: %s", err.Error())
- }
- subdomain := dnsRecord.ExternalURL
- if ingressVal, ok := mergedValues["ingress"]; !ok {
- mergedValues["ingress"] = map[string]interface{}{
- "porter_hosts": []string{
- subdomain,
- },
- }
- } else {
- ingressValMap := ingressVal.(map[string]interface{})
- ingressValMap["porter_hosts"] = []string{
- subdomain,
- }
- }
- }
- }
- }
- return nil
- }
- func createDNSRecord(opts SubdomainCreateOpts) (*types.DNSRecord, error) {
- if opts.dnsClient == nil {
- return nil, fmt.Errorf("cannot create subdomain because dns client is nil")
- }
- endpoint, found, err := domain.GetNGINXIngressServiceIP(opts.k8sAgent.Clientset)
- if err != nil {
- return nil, err
- }
- if !found {
- return nil, fmt.Errorf("target cluster does not have nginx ingress")
- }
- createDomain := domain.CreateDNSRecordConfig{
- ReleaseName: opts.stackName,
- RootDomain: opts.appRootDomain,
- Endpoint: endpoint,
- }
- record := createDomain.NewDNSRecordForEndpoint()
- record, err = opts.dnsRepo.CreateDNSRecord(record)
- if err != nil {
- return nil, err
- }
- _record := domain.DNSRecord(*record)
- err = _record.CreateDomain(opts.dnsClient)
- if err != nil {
- return nil, err
- }
- return record.ToDNSRecordType(), nil
- }
- func getNestedMap(obj map[string]interface{}, fields ...string) (map[string]interface{}, error) {
- var res map[string]interface{}
- curr := obj
- for _, field := range fields {
- objField, ok := curr[field]
- if !ok {
- return nil, fmt.Errorf("%s not found", field)
- }
- res, ok = objField.(map[string]interface{})
- if !ok {
- return nil, fmt.Errorf("%s is not a nested object", field)
- }
- curr = res
- }
- return res, nil
- }
- func getHelmName(alias string, t string) string {
- var suffix string
- if t == "web" {
- suffix = "-web"
- } else if t == "worker" {
- suffix = "-wkr"
- } else if t == "job" {
- suffix = "-job"
- }
- return fmt.Sprintf("%s%s", alias, suffix)
- }
- func getChartTypeFromHelmName(name string) string {
- if strings.HasSuffix(name, "-web") {
- return "web"
- } else if strings.HasSuffix(name, "-wkr") {
- return "worker"
- } else if strings.HasSuffix(name, "-job") {
- return "job"
- }
- return ""
- }
- func getServiceNameAndTypeFromHelmName(name string) (string, string) {
- if strings.HasSuffix(name, "-web") {
- return strings.TrimSuffix(name, "-web"), "web"
- } else if strings.HasSuffix(name, "-wkr") {
- return strings.TrimSuffix(name, "-wkr"), "worker"
- } else if strings.HasSuffix(name, "-job") {
- return strings.TrimSuffix(name, "-job"), "job"
- }
- return "", ""
- }
- func attemptToGetImageInfoFromRelease(values map[string]interface{}) types.ImageInfo {
- imageInfo := types.ImageInfo{}
- if values == nil {
- return imageInfo
- }
- globalImage, err := getNestedMap(values, "global", "image")
- if err != nil {
- return imageInfo
- }
- repoVal, okRepo := globalImage["repository"]
- tagVal, okTag := globalImage["tag"]
- if okRepo && okTag {
- imageInfo.Repository = repoVal.(string)
- imageInfo.Tag = tagVal.(string)
- }
- return imageInfo
- }
- func attemptToGetImageInfoFromFullHelmValues(fullHelmValues string) (types.ImageInfo, error) {
- imageInfo := types.ImageInfo{}
- var values map[string]interface{}
- err := yaml.Unmarshal([]byte(fullHelmValues), &values)
- if err != nil {
- return imageInfo, fmt.Errorf("error unmarshaling full helm values to read image info: %w", err)
- }
- convertedValues := convertMap(values).(map[string]interface{})
- return attemptToGetImageInfoFromRelease(convertedValues), nil
- }
- func getStacksNestedMap(obj map[string]interface{}, fields ...string) ([]map[string]interface{}, error) {
- var res map[string]interface{}
- curr := obj
- for _, field := range fields {
- objField, ok := curr[field]
- if !ok {
- return nil, fmt.Errorf("%s not found", field)
- }
- res, ok = objField.(map[string]interface{})
- if !ok {
- return nil, fmt.Errorf("%s is not a nested object", field)
- }
- curr = res
- }
- syncedInterface, ok := curr["synced"]
- if !ok {
- return nil, fmt.Errorf("synced not found")
- }
- synced, ok := syncedInterface.([]interface{})
- if !ok {
- return nil, fmt.Errorf("synced is not a slice of interface{}")
- }
- result := make([]map[string]interface{}, len(synced))
- for i, v := range synced {
- mapElement, ok := v.(map[string]interface{})
- if !ok {
- return nil, fmt.Errorf("element %d in synced is not a map[string]interface{}", i)
- }
- result[i] = mapElement
- }
- return result, nil
- }
- func convertHelmValuesToPorterYaml(helmValues string) (*PorterStackYAML, error) {
- var values map[string]interface{}
- err := yaml.Unmarshal([]byte(helmValues), &values)
- if err != nil {
- return nil, err
- }
- services := make(map[string]*Service)
- for k, v := range values {
- if k == "global" {
- continue
- }
- serviceName, serviceType := getServiceNameAndTypeFromHelmName(k)
- if serviceName == "" {
- return nil, fmt.Errorf("invalid service key: %s. make sure that service key ends in either -web, -wkr, or -job", k)
- }
- config := convertMap(v).(map[string]interface{})
- var runCommand string
- if config["container"] != nil {
- containerMap := config["container"].(map[string]interface{})
- if containerMap["command"] != nil {
- runCommand = containerMap["command"].(string)
- }
- }
- services[serviceName] = &Service{
- Run: &runCommand,
- Config: config,
- Type: &serviceType,
- }
- }
- return &PorterStackYAML{
- Services: services,
- }, nil
- }
- // addLabelsToService always adds the default label to the service, and if envGroups is not empty, it adds the corresponding environment group label as well.
- func addLabelsToService(service *Service, envGroups []string, defaultLabelKey string) *Service {
- if _, ok := service.Config["labels"]; !ok {
- service.Config["labels"] = make(map[string]string)
- }
- if len(envGroups) != 0 {
- // delete the env group label so we can replace it
- if _, ok := service.Config["labels"].(map[string]any); ok {
- delete(service.Config["labels"].(map[string]any), environment_groups.LabelKey_LinkedEnvironmentGroup)
- }
- }
- switch service.Config["labels"].(type) {
- case map[string]string:
- service.Config["labels"].(map[string]string)[defaultLabelKey] = porter_app.LabelValue_PorterApplication
- if len(envGroups) != 0 {
- service.Config["labels"].(map[string]string)[environment_groups.LabelKey_LinkedEnvironmentGroup] = strings.Join(envGroups, ".")
- }
- case map[string]any:
- service.Config["labels"].(map[string]any)[defaultLabelKey] = porter_app.LabelValue_PorterApplication
- if len(envGroups) != 0 {
- service.Config["labels"].(map[string]any)[environment_groups.LabelKey_LinkedEnvironmentGroup] = strings.Join(envGroups, ".")
- }
- case any:
- if val, ok := service.Config["labels"].(string); ok {
- if val == "" {
- service.Config["labels"] = map[string]string{
- defaultLabelKey: porter_app.LabelValue_PorterApplication,
- }
- if len(envGroups) != 0 {
- service.Config["labels"].(map[string]string)[environment_groups.LabelKey_LinkedEnvironmentGroup] = strings.Join(envGroups, ".")
- }
- }
- }
- }
- if _, ok := service.Config["podLabels"]; !ok {
- service.Config["podLabels"] = make(map[string]string)
- }
- switch service.Config["podLabels"].(type) {
- case map[string]string:
- service.Config["podLabels"].(map[string]string)[defaultLabelKey] = porter_app.LabelValue_PorterApplication
- case map[string]any:
- service.Config["podLabels"].(map[string]any)[defaultLabelKey] = porter_app.LabelValue_PorterApplication
- case any:
- if val, ok := service.Config["podLabels"].(string); ok {
- if val == "" {
- service.Config["podLabels"] = map[string]string{
- defaultLabelKey: porter_app.LabelValue_PorterApplication,
- }
- }
- }
- }
- return service
- }
- func getServiceDeploymentMetadataFromValues(values map[string]interface{}, status types.PorterAppEventStatus) map[string]types.ServiceDeploymentMetadata {
- serviceDeploymentMap := make(map[string]types.ServiceDeploymentMetadata)
- for key := range values {
- if key != "global" {
- serviceName, serviceType := getServiceNameAndTypeFromHelmName(key)
- externalURI := getServiceExternalURIFromServiceValues(values[key].(map[string]interface{}))
- // jobs don't technically have a deployment, so hardcode the deployment status to success
- serviceStatus := status
- if serviceType == "job" {
- serviceStatus = types.PorterAppEventStatus_Success
- }
- serviceDeploymentMap[serviceName] = types.ServiceDeploymentMetadata{
- ExternalURI: externalURI,
- Status: serviceStatus,
- Type: serviceType,
- }
- }
- }
- return serviceDeploymentMap
- }
- func getServiceExternalURIFromServiceValues(serviceValues map[string]interface{}) string {
- ingressMap, err := getNestedMap(serviceValues, "ingress")
- if err == nil {
- enabledVal, enabledExists := ingressMap["enabled"]
- if enabledExists {
- enabled, eOK := enabledVal.(bool)
- if eOK && enabled {
- customDomVal, customDomExists := ingressMap["custom_domain"]
- if customDomExists {
- customDomain, cOK := customDomVal.(bool)
- if cOK && customDomain {
- hostsExists, hostsExistsOK := ingressMap["hosts"]
- if hostsExistsOK {
- if hosts, hostsOK := hostsExists.([]interface{}); hostsOK && len(hosts) == 1 {
- return hosts[0].(string)
- }
- }
- }
- }
- if porterHosts, ok := ingressMap["porter_hosts"].([]interface{}); ok && len(porterHosts) == 1 {
- return porterHosts[0].(string)
- }
- }
- }
- }
- return ""
- }
|