mirror of
https://github.com/argoproj/argo-cd
synced 2026-05-24 09:50:08 +00:00
Currently, the usage of standard lua library is always disabled, making it difficult to implement complex health check scripts. This feat allow admins to control the usage of standard library by setting "health.lua.useOpenLibs" (merged-keys convention)/"resource.customizations.useOpenLibs.<group_kind>" (split-keys convention) field in argocd-cm ConfigMap. Signed-off-by: Chetan Banavikalmutt <chetanrns1997@gmail.com>
1548 lines
51 KiB
Go
1548 lines
51 KiB
Go
package settings
|
|
|
|
import (
|
|
"context"
|
|
"crypto/sha256"
|
|
"crypto/tls"
|
|
"crypto/x509"
|
|
"encoding/base64"
|
|
"fmt"
|
|
"net/url"
|
|
"path"
|
|
"reflect"
|
|
"strconv"
|
|
"strings"
|
|
"sync"
|
|
"time"
|
|
|
|
timeutil "github.com/argoproj/pkg/time"
|
|
"github.com/ghodss/yaml"
|
|
log "github.com/sirupsen/logrus"
|
|
apiv1 "k8s.io/api/core/v1"
|
|
apierr "k8s.io/apimachinery/pkg/api/errors"
|
|
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/fields"
|
|
v1 "k8s.io/client-go/informers/core/v1"
|
|
"k8s.io/client-go/kubernetes"
|
|
v1listers "k8s.io/client-go/listers/core/v1"
|
|
"k8s.io/client-go/tools/cache"
|
|
|
|
"github.com/argoproj/argo-cd/v2/common"
|
|
"github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
|
|
"github.com/argoproj/argo-cd/v2/server/settings/oidc"
|
|
"github.com/argoproj/argo-cd/v2/util"
|
|
"github.com/argoproj/argo-cd/v2/util/kube"
|
|
"github.com/argoproj/argo-cd/v2/util/password"
|
|
argorand "github.com/argoproj/argo-cd/v2/util/rand"
|
|
tlsutil "github.com/argoproj/argo-cd/v2/util/tls"
|
|
)
|
|
|
|
// ArgoCDSettings holds in-memory runtime configuration options.
|
|
type ArgoCDSettings struct {
|
|
// URL is the externally facing URL users will visit to reach Argo CD.
|
|
// The value here is used when configuring SSO. Omitting this value will disable SSO.
|
|
URL string `json:"url,omitempty"`
|
|
// Indicates if status badge is enabled or not.
|
|
StatusBadgeEnabled bool `json:"statusBadgeEnable"`
|
|
// DexConfig contains portions of a dex config yaml
|
|
DexConfig string `json:"dexConfig,omitempty"`
|
|
// OIDCConfigRAW holds OIDC configuration as a raw string
|
|
OIDCConfigRAW string `json:"oidcConfig,omitempty"`
|
|
// ServerSignature holds the key used to generate JWT tokens.
|
|
ServerSignature []byte `json:"serverSignature,omitempty"`
|
|
// Certificate holds the certificate/private key for the Argo CD API server.
|
|
// If nil, will run insecure without TLS.
|
|
Certificate *tls.Certificate `json:"-"`
|
|
// CertificateIsExternal indicates whether Certificate was loaded from external secret
|
|
CertificateIsExternal bool `json:"-"`
|
|
// WebhookGitLabSecret holds the shared secret for authenticating GitHub webhook events
|
|
WebhookGitHubSecret string `json:"webhookGitHubSecret,omitempty"`
|
|
// WebhookGitLabSecret holds the shared secret for authenticating GitLab webhook events
|
|
WebhookGitLabSecret string `json:"webhookGitLabSecret,omitempty"`
|
|
// WebhookBitbucketUUID holds the UUID for authenticating Bitbucket webhook events
|
|
WebhookBitbucketUUID string `json:"webhookBitbucketUUID,omitempty"`
|
|
// WebhookBitbucketServerSecret holds the shared secret for authenticating BitbucketServer webhook events
|
|
WebhookBitbucketServerSecret string `json:"webhookBitbucketServerSecret,omitempty"`
|
|
// WebhookGogsSecret holds the shared secret for authenticating Gogs webhook events
|
|
WebhookGogsSecret string `json:"webhookGogsSecret,omitempty"`
|
|
// Secrets holds all secrets in argocd-secret as a map[string]string
|
|
Secrets map[string]string `json:"secrets,omitempty"`
|
|
// KustomizeBuildOptions is a string of kustomize build parameters
|
|
KustomizeBuildOptions string `json:"kustomizeBuildOptions,omitempty"`
|
|
// Indicates if anonymous user is enabled or not
|
|
AnonymousUserEnabled bool `json:"anonymousUserEnabled,omitempty"`
|
|
// Specifies token expiration duration
|
|
UserSessionDuration time.Duration `json:"userSessionDuration,omitempty"`
|
|
// UiCssURL local or remote path to user-defined CSS to customize ArgoCD UI
|
|
UiCssURL string `json:"uiCssURL,omitempty"`
|
|
// Content of UI Banner
|
|
UiBannerContent string `json:"uiBannerContent,omitempty"`
|
|
// URL for UI Banner
|
|
UiBannerURL string `json:"uiBannerURL,omitempty"`
|
|
}
|
|
|
|
type GoogleAnalytics struct {
|
|
TrackingID string `json:"trackingID,omitempty"`
|
|
AnonymizeUsers bool `json:"anonymizeUsers,omitempty"`
|
|
}
|
|
|
|
type GlobalProjectSettings struct {
|
|
ProjectName string `json:"projectName,omitempty"`
|
|
LabelSelector metav1.LabelSelector `json:"labelSelector,omitempty"`
|
|
}
|
|
|
|
// Help settings
|
|
type Help struct {
|
|
// the URL for getting chat help, this will typically be your Slack channel for support
|
|
ChatURL string `json:"chatUrl,omitempty"`
|
|
// the text for getting chat help, defaults to "Chat now!"
|
|
ChatText string `json:"chatText,omitempty"`
|
|
}
|
|
|
|
type OIDCConfig struct {
|
|
Name string `json:"name,omitempty"`
|
|
Issuer string `json:"issuer,omitempty"`
|
|
ClientID string `json:"clientID,omitempty"`
|
|
ClientSecret string `json:"clientSecret,omitempty"`
|
|
CLIClientID string `json:"cliClientID,omitempty"`
|
|
RequestedScopes []string `json:"requestedScopes,omitempty"`
|
|
RequestedIDTokenClaims map[string]*oidc.Claim `json:"requestedIDTokenClaims,omitempty"`
|
|
LogoutURL string `json:"logoutURL,omitempty"`
|
|
}
|
|
|
|
// DEPRECATED. Helm repository credentials are now managed using RepoCredentials
|
|
type HelmRepoCredentials struct {
|
|
URL string `json:"url,omitempty"`
|
|
Name string `json:"name,omitempty"`
|
|
UsernameSecret *apiv1.SecretKeySelector `json:"usernameSecret,omitempty"`
|
|
PasswordSecret *apiv1.SecretKeySelector `json:"passwordSecret,omitempty"`
|
|
CertSecret *apiv1.SecretKeySelector `json:"certSecret,omitempty"`
|
|
KeySecret *apiv1.SecretKeySelector `json:"keySecret,omitempty"`
|
|
}
|
|
|
|
// KustomizeVersion holds information about additional Kustomize version
|
|
type KustomizeVersion struct {
|
|
// Name holds Kustomize version name
|
|
Name string
|
|
// Path holds corresponding binary path
|
|
Path string
|
|
// BuildOptions that are specific to Kustomize version
|
|
BuildOptions string
|
|
}
|
|
|
|
// KustomizeSettings holds kustomize settings
|
|
type KustomizeSettings struct {
|
|
BuildOptions string
|
|
Versions []KustomizeVersion
|
|
}
|
|
|
|
func (ks *KustomizeSettings) GetOptions(source v1alpha1.ApplicationSource) (*v1alpha1.KustomizeOptions, error) {
|
|
binaryPath := ""
|
|
buildOptions := ""
|
|
if source.Kustomize != nil && source.Kustomize.Version != "" {
|
|
for _, ver := range ks.Versions {
|
|
if ver.Name == source.Kustomize.Version {
|
|
// add version specific path and build options
|
|
binaryPath = ver.Path
|
|
buildOptions = ver.BuildOptions
|
|
break
|
|
}
|
|
}
|
|
if binaryPath == "" {
|
|
return nil, fmt.Errorf("kustomize version %s is not registered", source.Kustomize.Version)
|
|
}
|
|
} else {
|
|
// add build options for the default version
|
|
buildOptions = ks.BuildOptions
|
|
}
|
|
return &v1alpha1.KustomizeOptions{
|
|
BuildOptions: buildOptions,
|
|
BinaryPath: binaryPath,
|
|
}, nil
|
|
}
|
|
|
|
// Credentials for accessing a Git repository
|
|
type Repository struct {
|
|
// The URL to the repository
|
|
URL string `json:"url,omitempty"`
|
|
// the type of the repo, "git" or "helm", assumed to be "git" if empty or absent
|
|
Type string `json:"type,omitempty"`
|
|
// helm only
|
|
Name string `json:"name,omitempty"`
|
|
// Name of the secret storing the username used to access the repo
|
|
UsernameSecret *apiv1.SecretKeySelector `json:"usernameSecret,omitempty"`
|
|
// Name of the secret storing the password used to access the repo
|
|
PasswordSecret *apiv1.SecretKeySelector `json:"passwordSecret,omitempty"`
|
|
// Name of the secret storing the SSH private key used to access the repo. Git only
|
|
SSHPrivateKeySecret *apiv1.SecretKeySelector `json:"sshPrivateKeySecret,omitempty"`
|
|
// Whether to connect the repository in an insecure way (deprecated)
|
|
InsecureIgnoreHostKey bool `json:"insecureIgnoreHostKey,omitempty"`
|
|
// Whether to connect the repository in an insecure way
|
|
Insecure bool `json:"insecure,omitempty"`
|
|
// Whether the repo is git-lfs enabled. Git only.
|
|
EnableLFS bool `json:"enableLfs,omitempty"`
|
|
// Name of the secret storing the TLS client cert data
|
|
TLSClientCertDataSecret *apiv1.SecretKeySelector `json:"tlsClientCertDataSecret,omitempty"`
|
|
// Name of the secret storing the TLS client cert's key data
|
|
TLSClientCertKeySecret *apiv1.SecretKeySelector `json:"tlsClientCertKeySecret,omitempty"`
|
|
// Whether the repo is helm-oci enabled. Git only.
|
|
EnableOci bool `json:"enableOci,omitempty"`
|
|
// Github App Private Key PEM data
|
|
GithubAppPrivateKeySecret *apiv1.SecretKeySelector `json:"githubAppPrivateKeySecret,omitempty"`
|
|
// Github App ID of the app used to access the repo
|
|
GithubAppId int64 `json:"githubAppID,omitempty"`
|
|
// Github App Installation ID of the installed GitHub App
|
|
GithubAppInstallationId int64 `json:"githubAppInstallationID,omitempty"`
|
|
// Github App Enterprise base url if empty will default to https://api.github.com
|
|
GithubAppEnterpriseBaseURL string `json:"githubAppEnterpriseBaseUrl,omitempty"`
|
|
}
|
|
|
|
// Credential template for accessing repositories
|
|
type RepositoryCredentials struct {
|
|
// The URL pattern the repository URL has to match
|
|
URL string `json:"url,omitempty"`
|
|
// Name of the secret storing the username used to access the repo
|
|
UsernameSecret *apiv1.SecretKeySelector `json:"usernameSecret,omitempty"`
|
|
// Name of the secret storing the password used to access the repo
|
|
PasswordSecret *apiv1.SecretKeySelector `json:"passwordSecret,omitempty"`
|
|
// Name of the secret storing the SSH private key used to access the repo. Git only
|
|
SSHPrivateKeySecret *apiv1.SecretKeySelector `json:"sshPrivateKeySecret,omitempty"`
|
|
// Name of the secret storing the TLS client cert data
|
|
TLSClientCertDataSecret *apiv1.SecretKeySelector `json:"tlsClientCertDataSecret,omitempty"`
|
|
// Name of the secret storing the TLS client cert's key data
|
|
TLSClientCertKeySecret *apiv1.SecretKeySelector `json:"tlsClientCertKeySecret,omitempty"`
|
|
// Github App Private Key PEM data
|
|
GithubAppPrivateKeySecret *apiv1.SecretKeySelector `json:"githubAppPrivateKeySecret,omitempty"`
|
|
// Github App ID of the app used to access the repo
|
|
GithubAppId int64 `json:"githubAppID,omitempty"`
|
|
// Github App Installation ID of the installed GitHub App
|
|
GithubAppInstallationId int64 `json:"githubAppInstallationID,omitempty"`
|
|
// Github App Enterprise base url if empty will default to https://api.github.com
|
|
GithubAppEnterpriseBaseURL string `json:"githubAppEnterpriseBaseUrl,omitempty"`
|
|
// EnableOCI specifies whether helm-oci support should be enabled for this repo
|
|
EnableOCI bool `json:"enableOCI,omitempty"`
|
|
// the type of the repositoryCredentials, "git" or "helm", assumed to be "git" if empty or absent
|
|
Type string `json:"type,omitempty"`
|
|
}
|
|
|
|
const (
|
|
// settingServerSignatureKey designates the key for a server secret key inside a Kubernetes secret.
|
|
settingServerSignatureKey = "server.secretkey"
|
|
// gaTrackingID holds Google Analytics tracking id
|
|
gaTrackingID = "ga.trackingid"
|
|
// the URL for getting chat help, this will typically be your Slack channel for support
|
|
helpChatURL = "help.chatUrl"
|
|
// the text for getting chat help, defaults to "Chat now!"
|
|
helpChatText = "help.chatText"
|
|
// gaAnonymizeUsers specifies if user ids should be anonymized (hashed) before sending to Google Analytics. True unless value is set to 'false'
|
|
gaAnonymizeUsers = "ga.anonymizeusers"
|
|
// settingServerCertificate designates the key for the public cert used in TLS
|
|
settingServerCertificate = "tls.crt"
|
|
// settingServerPrivateKey designates the key for the private key used in TLS
|
|
settingServerPrivateKey = "tls.key"
|
|
// settingURLKey designates the key where Argo CD's external URL is set
|
|
settingURLKey = "url"
|
|
// repositoriesKey designates the key where ArgoCDs repositories list is set
|
|
repositoriesKey = "repositories"
|
|
// repositoryCredentialsKey designates the key where ArgoCDs repositories credentials list is set
|
|
repositoryCredentialsKey = "repository.credentials"
|
|
// helmRepositoriesKey designates the key where list of helm repositories is set
|
|
helmRepositoriesKey = "helm.repositories"
|
|
// settingDexConfigKey designates the key for the dex config
|
|
settingDexConfigKey = "dex.config"
|
|
// settingsOIDCConfigKey designates the key for OIDC config
|
|
settingsOIDCConfigKey = "oidc.config"
|
|
// statusBadgeEnabledKey holds the key which enables of disables status badge feature
|
|
statusBadgeEnabledKey = "statusbadge.enabled"
|
|
// settingsWebhookGitHubSecret is the key for the GitHub shared webhook secret
|
|
settingsWebhookGitHubSecretKey = "webhook.github.secret"
|
|
// settingsWebhookGitLabSecret is the key for the GitLab shared webhook secret
|
|
settingsWebhookGitLabSecretKey = "webhook.gitlab.secret"
|
|
// settingsWebhookBitbucketUUID is the key for Bitbucket webhook UUID
|
|
settingsWebhookBitbucketUUIDKey = "webhook.bitbucket.uuid"
|
|
// settingsWebhookBitbucketServerSecret is the key for BitbucketServer webhook secret
|
|
settingsWebhookBitbucketServerSecretKey = "webhook.bitbucketserver.secret"
|
|
// settingsWebhookGogsSecret is the key for Gogs webhook secret
|
|
settingsWebhookGogsSecretKey = "webhook.gogs.secret"
|
|
// settingsApplicationInstanceLabelKey is the key to configure injected app instance label key
|
|
settingsApplicationInstanceLabelKey = "application.instanceLabelKey"
|
|
// resourcesCustomizationsKey is the key to the map of resource overrides
|
|
resourceCustomizationsKey = "resource.customizations"
|
|
// resourceExclusions is the key to the list of excluded resources
|
|
resourceExclusionsKey = "resource.exclusions"
|
|
// resourceInclusions is the key to the list of explicitly watched resources
|
|
resourceInclusionsKey = "resource.inclusions"
|
|
// configManagementPluginsKey is the key to the list of config management plugins
|
|
configManagementPluginsKey = "configManagementPlugins"
|
|
// kustomizeBuildOptionsKey is a string of kustomize build parameters
|
|
kustomizeBuildOptionsKey = "kustomize.buildOptions"
|
|
// kustomizeVersionKeyPrefix is a kustomize version key prefix
|
|
kustomizeVersionKeyPrefix = "kustomize.version"
|
|
// kustomizePathPrefixKey is a kustomize path for a specific version
|
|
kustomizePathPrefixKey = "kustomize.path"
|
|
// anonymousUserEnabledKey is the key which enables or disables anonymous user
|
|
anonymousUserEnabledKey = "users.anonymous.enabled"
|
|
// anonymousUserEnabledKey is the key which specifies token expiration duration
|
|
userSessionDurationKey = "users.session.duration"
|
|
// diffOptions is the key where diff options are configured
|
|
resourceCompareOptionsKey = "resource.compareoptions"
|
|
// settingUiCssURLKey designates the key for user-defined CSS URL for UI customization
|
|
settingUiCssURLKey = "ui.cssurl"
|
|
// settingUiBannerContentKey designates the key for content of user-defined info banner for UI
|
|
settingUiBannerContentKey = "ui.bannercontent"
|
|
// settingUiBannerURLKey designates the key for the link for user-defined info banner for UI
|
|
settingUiBannerURLKey = "ui.bannerurl"
|
|
// globalProjectsKey designates the key for global project settings
|
|
globalProjectsKey = "globalProjects"
|
|
// initialPasswordSecretName is the name of the secret that will hold the initial admin password
|
|
initialPasswordSecretName = "argocd-initial-admin-secret"
|
|
// initialPasswordSecretField is the name of the field in initialPasswordSecretName to store the password
|
|
initialPasswordSecretField = "password"
|
|
// initialPasswordLength defines the length of the generated initial password
|
|
initialPasswordLength = 16
|
|
// externalServerTLSSecretName defines the name of the external secret holding the server's TLS certificate
|
|
externalServerTLSSecretName = "argocd-server-tls"
|
|
)
|
|
|
|
// SettingsManager holds config info for a new manager with which to access Kubernetes ConfigMaps.
|
|
type SettingsManager struct {
|
|
ctx context.Context
|
|
clientset kubernetes.Interface
|
|
secrets v1listers.SecretLister
|
|
configmaps v1listers.ConfigMapLister
|
|
namespace string
|
|
// subscribers is a list of subscribers to settings updates
|
|
subscribers []chan<- *ArgoCDSettings
|
|
// mutex protects concurrency sensitive parts of settings manager: access to subscribers list and initialization flag
|
|
mutex *sync.Mutex
|
|
initContextCancel func()
|
|
reposCache []Repository
|
|
repoCredsCache []RepositoryCredentials
|
|
}
|
|
|
|
type incompleteSettingsError struct {
|
|
message string
|
|
}
|
|
|
|
type IgnoreStatus string
|
|
|
|
const (
|
|
// IgnoreResourceStatusInCRD ignores status changes for all CRDs
|
|
IgnoreResourceStatusInCRD IgnoreStatus = "crd"
|
|
// IgnoreResourceStatusInAll ignores status changes for all resources
|
|
IgnoreResourceStatusInAll IgnoreStatus = "all"
|
|
// IgnoreResourceStatusInNone ignores status changes for no resources
|
|
IgnoreResourceStatusInNone IgnoreStatus = "off"
|
|
)
|
|
|
|
type ArgoCDDiffOptions struct {
|
|
IgnoreAggregatedRoles bool `json:"ignoreAggregatedRoles,omitempty"`
|
|
|
|
// If set to true then differences caused by status are ignored.
|
|
IgnoreResourceStatusField IgnoreStatus `json:"ignoreResourceStatusField,omitempty"`
|
|
}
|
|
|
|
func (e *incompleteSettingsError) Error() string {
|
|
return e.message
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetSecretsLister() (v1listers.SecretLister, error) {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return mgr.secrets, nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) updateSecret(callback func(*apiv1.Secret) error) error {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
argoCDSecret, err := mgr.secrets.Secrets(mgr.namespace).Get(common.ArgoCDSecretName)
|
|
createSecret := false
|
|
if err != nil {
|
|
if !apierr.IsNotFound(err) {
|
|
return err
|
|
}
|
|
argoCDSecret = &apiv1.Secret{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: common.ArgoCDSecretName,
|
|
},
|
|
Data: make(map[string][]byte),
|
|
}
|
|
createSecret = true
|
|
}
|
|
if argoCDSecret.Data == nil {
|
|
argoCDSecret.Data = make(map[string][]byte)
|
|
}
|
|
|
|
updatedSecret := argoCDSecret.DeepCopy()
|
|
err = callback(updatedSecret)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if !createSecret && reflect.DeepEqual(argoCDSecret, updatedSecret) {
|
|
return nil
|
|
}
|
|
|
|
if createSecret {
|
|
_, err = mgr.clientset.CoreV1().Secrets(mgr.namespace).Create(context.Background(), updatedSecret, metav1.CreateOptions{})
|
|
} else {
|
|
_, err = mgr.clientset.CoreV1().Secrets(mgr.namespace).Update(context.Background(), updatedSecret, metav1.UpdateOptions{})
|
|
}
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return mgr.ResyncInformers()
|
|
}
|
|
|
|
func (mgr *SettingsManager) updateConfigMap(callback func(*apiv1.ConfigMap) error) error {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
createCM := false
|
|
if err != nil {
|
|
if !apierr.IsNotFound(err) {
|
|
return err
|
|
}
|
|
argoCDCM = &apiv1.ConfigMap{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: common.ArgoCDConfigMapName,
|
|
},
|
|
}
|
|
createCM = true
|
|
}
|
|
if argoCDCM.Data == nil {
|
|
argoCDCM.Data = make(map[string]string)
|
|
}
|
|
err = callback(argoCDCM)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if createCM {
|
|
_, err = mgr.clientset.CoreV1().ConfigMaps(mgr.namespace).Create(context.Background(), argoCDCM, metav1.CreateOptions{})
|
|
} else {
|
|
_, err = mgr.clientset.CoreV1().ConfigMaps(mgr.namespace).Update(context.Background(), argoCDCM, metav1.UpdateOptions{})
|
|
}
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
mgr.invalidateCache()
|
|
|
|
return mgr.ResyncInformers()
|
|
}
|
|
|
|
func (mgr *SettingsManager) getConfigMap() (*apiv1.ConfigMap, error) {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
argoCDCM, err := mgr.configmaps.ConfigMaps(mgr.namespace).Get(common.ArgoCDConfigMapName)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if argoCDCM.Data == nil {
|
|
argoCDCM.Data = make(map[string]string)
|
|
}
|
|
return argoCDCM, err
|
|
}
|
|
|
|
// Returns the ConfigMap with the given name from the cluster.
|
|
// The ConfigMap must be labeled with "app.kubernetes.io/part-of: argocd" in
|
|
// order to be retrievable.
|
|
func (mgr *SettingsManager) GetConfigMapByName(configMapName string) (*apiv1.ConfigMap, error) {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
configMap, err := mgr.configmaps.ConfigMaps(mgr.namespace).Get(configMapName)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return configMap, err
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetResourcesFilter() (*ResourcesFilter, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
rf := &ResourcesFilter{}
|
|
if value, ok := argoCDCM.Data[resourceInclusionsKey]; ok {
|
|
includedResources := make([]FilteredResource, 0)
|
|
err := yaml.Unmarshal([]byte(value), &includedResources)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
rf.ResourceInclusions = includedResources
|
|
}
|
|
|
|
if value, ok := argoCDCM.Data[resourceExclusionsKey]; ok {
|
|
excludedResources := make([]FilteredResource, 0)
|
|
err := yaml.Unmarshal([]byte(value), &excludedResources)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
rf.ResourceExclusions = excludedResources
|
|
}
|
|
return rf, nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetAppInstanceLabelKey() (string, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
label := argoCDCM.Data[settingsApplicationInstanceLabelKey]
|
|
if label == "" {
|
|
return common.LabelKeyAppInstance, nil
|
|
}
|
|
return label, nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetConfigManagementPlugins() ([]v1alpha1.ConfigManagementPlugin, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
plugins := make([]v1alpha1.ConfigManagementPlugin, 0)
|
|
if value, ok := argoCDCM.Data[configManagementPluginsKey]; ok {
|
|
err := yaml.Unmarshal([]byte(value), &plugins)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return plugins, nil
|
|
}
|
|
|
|
// GetResourceOverrides loads Resource Overrides from argocd-cm ConfigMap
|
|
func (mgr *SettingsManager) GetResourceOverrides() (map[string]v1alpha1.ResourceOverride, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
resourceOverrides := map[string]v1alpha1.ResourceOverride{}
|
|
if value, ok := argoCDCM.Data[resourceCustomizationsKey]; ok && value != "" {
|
|
err := yaml.Unmarshal([]byte(value), &resourceOverrides)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
err = mgr.appendResourceOverridesFromSplitKeys(argoCDCM.Data, resourceOverrides)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var diffOptions ArgoCDDiffOptions
|
|
if value, ok := argoCDCM.Data[resourceCompareOptionsKey]; ok {
|
|
err := yaml.Unmarshal([]byte(value), &diffOptions)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
crdGK := "apiextensions.k8s.io/CustomResourceDefinition"
|
|
|
|
switch diffOptions.IgnoreResourceStatusField {
|
|
case "", "crd":
|
|
addStatusOverrideToGK(resourceOverrides, crdGK)
|
|
log.Info("Ignore status for CustomResourceDefinitions")
|
|
|
|
case "all":
|
|
addStatusOverrideToGK(resourceOverrides, "*/*")
|
|
log.Info("Ignore status for all objects")
|
|
|
|
case "off", "false":
|
|
log.Info("Not ignoring status for any object")
|
|
|
|
default:
|
|
addStatusOverrideToGK(resourceOverrides, crdGK)
|
|
log.Warnf("Unrecognized value for ignoreResourceStatusField - %s, ignore status for CustomResourceDefinitions", diffOptions.IgnoreResourceStatusField)
|
|
}
|
|
|
|
return resourceOverrides, nil
|
|
}
|
|
|
|
func addStatusOverrideToGK(resourceOverrides map[string]v1alpha1.ResourceOverride, groupKind string) {
|
|
if val, ok := resourceOverrides[groupKind]; ok {
|
|
val.IgnoreDifferences.JSONPointers = append(val.IgnoreDifferences.JSONPointers, "/status")
|
|
resourceOverrides[groupKind] = val
|
|
} else {
|
|
resourceOverrides[groupKind] = v1alpha1.ResourceOverride{
|
|
IgnoreDifferences: v1alpha1.OverrideIgnoreDiff{JSONPointers: []string{"/status"}},
|
|
}
|
|
}
|
|
}
|
|
|
|
func (mgr *SettingsManager) appendResourceOverridesFromSplitKeys(cmData map[string]string, resourceOverrides map[string]v1alpha1.ResourceOverride) error {
|
|
for k, v := range cmData {
|
|
if !strings.HasPrefix(k, resourceCustomizationsKey) {
|
|
continue
|
|
}
|
|
|
|
// config map key should be of format resource.customizations.<type>.<group-kind>
|
|
parts := strings.SplitN(k, ".", 4)
|
|
if len(parts) < 4 {
|
|
continue
|
|
}
|
|
|
|
overrideKey, err := convertToOverrideKey(parts[3])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
overrideVal, ok := resourceOverrides[overrideKey]
|
|
if !ok {
|
|
overrideVal = v1alpha1.ResourceOverride{}
|
|
}
|
|
|
|
customizationType := parts[2]
|
|
switch customizationType {
|
|
case "health":
|
|
overrideVal.HealthLua = v
|
|
case "useOpenLibs":
|
|
useOpenLibs, err := strconv.ParseBool(v)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
overrideVal.UseOpenLibs = useOpenLibs
|
|
case "actions":
|
|
overrideVal.Actions = v
|
|
case "ignoreDifferences":
|
|
overrideIgnoreDiff := v1alpha1.OverrideIgnoreDiff{}
|
|
err := yaml.Unmarshal([]byte(v), &overrideIgnoreDiff)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
overrideVal.IgnoreDifferences = overrideIgnoreDiff
|
|
case "knownTypeFields":
|
|
var knownTypeFields []v1alpha1.KnownTypeField
|
|
err := yaml.Unmarshal([]byte(v), &knownTypeFields)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
overrideVal.KnownTypeFields = knownTypeFields
|
|
default:
|
|
return fmt.Errorf("resource customization type %s not supported", customizationType)
|
|
}
|
|
resourceOverrides[overrideKey] = overrideVal
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Convert group-kind format to <group/kind>, allowed key format examples
|
|
// resource.customizations.health.cert-manager.io_Certificate
|
|
// resource.customizations.health.Certificate
|
|
func convertToOverrideKey(groupKind string) (string, error) {
|
|
parts := strings.Split(groupKind, "_")
|
|
if len(parts) == 2 {
|
|
return fmt.Sprintf("%s/%s", parts[0], parts[1]), nil
|
|
} else if len(parts) == 1 && groupKind != "" {
|
|
return groupKind, nil
|
|
}
|
|
return "", fmt.Errorf("group kind should be in format `resource.customizations.<type>.<group_kind>` or resource.customizations.<type>.<kind>`, got group kind: '%s'", groupKind)
|
|
}
|
|
|
|
func GetDefaultDiffOptions() ArgoCDDiffOptions {
|
|
return ArgoCDDiffOptions{IgnoreAggregatedRoles: false}
|
|
}
|
|
|
|
// GetResourceCompareOptions loads the resource compare options settings from the ConfigMap
|
|
func (mgr *SettingsManager) GetResourceCompareOptions() (ArgoCDDiffOptions, error) {
|
|
// We have a sane set of default diff options
|
|
diffOptions := GetDefaultDiffOptions()
|
|
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return diffOptions, err
|
|
}
|
|
|
|
if value, ok := argoCDCM.Data[resourceCompareOptionsKey]; ok {
|
|
err := yaml.Unmarshal([]byte(value), &diffOptions)
|
|
if err != nil {
|
|
return diffOptions, err
|
|
}
|
|
}
|
|
|
|
return diffOptions, nil
|
|
}
|
|
|
|
// GetKustomizeSettings loads the kustomize settings from argocd-cm ConfigMap
|
|
func (mgr *SettingsManager) GetKustomizeSettings() (*KustomizeSettings, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
kustomizeVersionsMap := map[string]KustomizeVersion{}
|
|
buildOptions := map[string]string{}
|
|
settings := &KustomizeSettings{}
|
|
|
|
// extract build options for the default version
|
|
if options, ok := argoCDCM.Data[kustomizeBuildOptionsKey]; ok {
|
|
settings.BuildOptions = options
|
|
}
|
|
|
|
// extract per-version binary paths and build options
|
|
for k, v := range argoCDCM.Data {
|
|
// extract version and path from kustomize.version.<version>
|
|
if strings.HasPrefix(k, kustomizeVersionKeyPrefix) {
|
|
err = addKustomizeVersion(kustomizeVersionKeyPrefix, k, v, kustomizeVersionsMap)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
// extract version and path from kustomize.path.<version>
|
|
if strings.HasPrefix(k, kustomizePathPrefixKey) {
|
|
err = addKustomizeVersion(kustomizePathPrefixKey, k, v, kustomizeVersionsMap)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
|
|
// extract version and build options from kustomize.buildOptions.<version>
|
|
if strings.HasPrefix(k, kustomizeBuildOptionsKey) && k != kustomizeBuildOptionsKey {
|
|
buildOptions[k[len(kustomizeBuildOptionsKey)+1:]] = v
|
|
}
|
|
}
|
|
|
|
for _, v := range kustomizeVersionsMap {
|
|
if _, ok := buildOptions[v.Name]; ok {
|
|
v.BuildOptions = buildOptions[v.Name]
|
|
}
|
|
settings.Versions = append(settings.Versions, v)
|
|
}
|
|
return settings, nil
|
|
}
|
|
|
|
func addKustomizeVersion(prefix, name, path string, kvMap map[string]KustomizeVersion) error {
|
|
version := name[len(prefix)+1:]
|
|
if _, ok := kvMap[version]; ok {
|
|
return fmt.Errorf("found duplicate kustomize version: %s", version)
|
|
}
|
|
kvMap[version] = KustomizeVersion{
|
|
Name: version,
|
|
Path: path,
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// DEPRECATED. Helm repository credentials are now managed using RepoCredentials
|
|
func (mgr *SettingsManager) GetHelmRepositories() ([]HelmRepoCredentials, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
helmRepositories := make([]HelmRepoCredentials, 0)
|
|
helmRepositoriesStr := argoCDCM.Data[helmRepositoriesKey]
|
|
if helmRepositoriesStr != "" {
|
|
err := yaml.Unmarshal([]byte(helmRepositoriesStr), &helmRepositories)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return helmRepositories, nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetRepositories() ([]Repository, error) {
|
|
|
|
mgr.mutex.Lock()
|
|
reposCache := mgr.reposCache
|
|
mgr.mutex.Unlock()
|
|
if reposCache != nil {
|
|
return reposCache, nil
|
|
}
|
|
|
|
// Get the config map outside of the lock
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
mgr.mutex.Lock()
|
|
defer mgr.mutex.Unlock()
|
|
repositories := make([]Repository, 0)
|
|
repositoriesStr := argoCDCM.Data[repositoriesKey]
|
|
if repositoriesStr != "" {
|
|
err := yaml.Unmarshal([]byte(repositoriesStr), &repositories)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
mgr.reposCache = repositories
|
|
|
|
return mgr.reposCache, nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) SaveRepositories(repos []Repository) error {
|
|
return mgr.updateConfigMap(func(argoCDCM *apiv1.ConfigMap) error {
|
|
if len(repos) > 0 {
|
|
yamlStr, err := yaml.Marshal(repos)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
argoCDCM.Data[repositoriesKey] = string(yamlStr)
|
|
} else {
|
|
delete(argoCDCM.Data, repositoriesKey)
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
func (mgr *SettingsManager) SaveRepositoryCredentials(creds []RepositoryCredentials) error {
|
|
return mgr.updateConfigMap(func(argoCDCM *apiv1.ConfigMap) error {
|
|
if len(creds) > 0 {
|
|
yamlStr, err := yaml.Marshal(creds)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
argoCDCM.Data[repositoryCredentialsKey] = string(yamlStr)
|
|
} else {
|
|
delete(argoCDCM.Data, repositoryCredentialsKey)
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetRepositoryCredentials() ([]RepositoryCredentials, error) {
|
|
|
|
mgr.mutex.Lock()
|
|
repoCredsCache := mgr.repoCredsCache
|
|
mgr.mutex.Unlock()
|
|
if repoCredsCache != nil {
|
|
return repoCredsCache, nil
|
|
}
|
|
|
|
// Get the config map outside of the lock
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
mgr.mutex.Lock()
|
|
defer mgr.mutex.Unlock()
|
|
creds := make([]RepositoryCredentials, 0)
|
|
credsStr := argoCDCM.Data[repositoryCredentialsKey]
|
|
if credsStr != "" {
|
|
err := yaml.Unmarshal([]byte(credsStr), &creds)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
mgr.repoCredsCache = creds
|
|
|
|
return mgr.repoCredsCache, nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetGoogleAnalytics() (*GoogleAnalytics, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &GoogleAnalytics{
|
|
TrackingID: argoCDCM.Data[gaTrackingID],
|
|
AnonymizeUsers: argoCDCM.Data[gaAnonymizeUsers] != "false",
|
|
}, nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) GetHelp() (*Help, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
chatText, ok := argoCDCM.Data[helpChatText]
|
|
if !ok {
|
|
chatText = "Chat now!"
|
|
}
|
|
return &Help{
|
|
ChatURL: argoCDCM.Data[helpChatURL],
|
|
ChatText: chatText,
|
|
}, nil
|
|
}
|
|
|
|
// GetSettings retrieves settings from the ArgoCDConfigMap and secret.
|
|
func (mgr *SettingsManager) GetSettings() (*ArgoCDSettings, error) {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
argoCDCM, err := mgr.configmaps.ConfigMaps(mgr.namespace).Get(common.ArgoCDConfigMapName)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
argoCDSecret, err := mgr.secrets.Secrets(mgr.namespace).Get(common.ArgoCDSecretName)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
var settings ArgoCDSettings
|
|
var errs []error
|
|
updateSettingsFromConfigMap(&settings, argoCDCM)
|
|
if err := mgr.updateSettingsFromSecret(&settings, argoCDSecret); err != nil {
|
|
errs = append(errs, err)
|
|
}
|
|
if len(errs) > 0 {
|
|
return &settings, errs[0]
|
|
}
|
|
|
|
return &settings, nil
|
|
}
|
|
|
|
// Clears cached settings on configmap/secret change
|
|
func (mgr *SettingsManager) invalidateCache() {
|
|
mgr.mutex.Lock()
|
|
defer mgr.mutex.Unlock()
|
|
|
|
mgr.reposCache = nil
|
|
mgr.repoCredsCache = nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) initialize(ctx context.Context) error {
|
|
tweakConfigMap := func(options *metav1.ListOptions) {
|
|
cmLabelSelector := fields.ParseSelectorOrDie("app.kubernetes.io/part-of=argocd")
|
|
options.LabelSelector = cmLabelSelector.String()
|
|
}
|
|
|
|
eventHandler := cache.ResourceEventHandlerFuncs{
|
|
UpdateFunc: func(oldObj, newObj interface{}) {
|
|
mgr.invalidateCache()
|
|
},
|
|
}
|
|
indexers := cache.Indexers{cache.NamespaceIndex: cache.MetaNamespaceIndexFunc}
|
|
cmInformer := v1.NewFilteredConfigMapInformer(mgr.clientset, mgr.namespace, 3*time.Minute, indexers, tweakConfigMap)
|
|
secretsInformer := v1.NewSecretInformer(mgr.clientset, mgr.namespace, 3*time.Minute, indexers)
|
|
cmInformer.AddEventHandler(eventHandler)
|
|
secretsInformer.AddEventHandler(eventHandler)
|
|
|
|
log.Info("Starting configmap/secret informers")
|
|
go func() {
|
|
cmInformer.Run(ctx.Done())
|
|
log.Info("configmap informer cancelled")
|
|
}()
|
|
go func() {
|
|
secretsInformer.Run(ctx.Done())
|
|
log.Info("secrets informer cancelled")
|
|
}()
|
|
|
|
if !cache.WaitForCacheSync(ctx.Done(), cmInformer.HasSynced, secretsInformer.HasSynced) {
|
|
return fmt.Errorf("Timed out waiting for settings cache to sync")
|
|
}
|
|
log.Info("Configmap/secret informer synced")
|
|
|
|
tryNotify := func() {
|
|
newSettings, err := mgr.GetSettings()
|
|
if err != nil {
|
|
log.Warnf("Unable to parse updated settings: %v", err)
|
|
} else {
|
|
mgr.notifySubscribers(newSettings)
|
|
}
|
|
}
|
|
now := time.Now()
|
|
handler := cache.ResourceEventHandlerFuncs{
|
|
AddFunc: func(obj interface{}) {
|
|
if metaObj, ok := obj.(metav1.Object); ok {
|
|
if metaObj.GetCreationTimestamp().After(now) {
|
|
tryNotify()
|
|
}
|
|
}
|
|
|
|
},
|
|
UpdateFunc: func(oldObj, newObj interface{}) {
|
|
oldMeta, oldOk := oldObj.(metav1.Common)
|
|
newMeta, newOk := newObj.(metav1.Common)
|
|
if oldOk && newOk && oldMeta.GetResourceVersion() != newMeta.GetResourceVersion() {
|
|
tryNotify()
|
|
}
|
|
},
|
|
}
|
|
secretsInformer.AddEventHandler(handler)
|
|
cmInformer.AddEventHandler(handler)
|
|
mgr.secrets = v1listers.NewSecretLister(secretsInformer.GetIndexer())
|
|
mgr.configmaps = v1listers.NewConfigMapLister(cmInformer.GetIndexer())
|
|
return nil
|
|
}
|
|
|
|
func (mgr *SettingsManager) ensureSynced(forceResync bool) error {
|
|
mgr.mutex.Lock()
|
|
defer mgr.mutex.Unlock()
|
|
if !forceResync && mgr.secrets != nil && mgr.configmaps != nil {
|
|
return nil
|
|
}
|
|
|
|
if mgr.initContextCancel != nil {
|
|
mgr.initContextCancel()
|
|
}
|
|
ctx, cancel := context.WithCancel(mgr.ctx)
|
|
mgr.initContextCancel = cancel
|
|
return mgr.initialize(ctx)
|
|
}
|
|
|
|
// updateSettingsFromConfigMap transfers settings from a Kubernetes configmap into an ArgoCDSettings struct.
|
|
func updateSettingsFromConfigMap(settings *ArgoCDSettings, argoCDCM *apiv1.ConfigMap) {
|
|
settings.DexConfig = argoCDCM.Data[settingDexConfigKey]
|
|
settings.OIDCConfigRAW = argoCDCM.Data[settingsOIDCConfigKey]
|
|
settings.KustomizeBuildOptions = argoCDCM.Data[kustomizeBuildOptionsKey]
|
|
settings.StatusBadgeEnabled = argoCDCM.Data[statusBadgeEnabledKey] == "true"
|
|
settings.AnonymousUserEnabled = argoCDCM.Data[anonymousUserEnabledKey] == "true"
|
|
settings.UiCssURL = argoCDCM.Data[settingUiCssURLKey]
|
|
settings.UiBannerContent = argoCDCM.Data[settingUiBannerContentKey]
|
|
if err := validateExternalURL(argoCDCM.Data[settingURLKey]); err != nil {
|
|
log.Warnf("Failed to validate URL in configmap: %v", err)
|
|
}
|
|
settings.URL = argoCDCM.Data[settingURLKey]
|
|
if err := validateExternalURL(argoCDCM.Data[settingUiBannerURLKey]); err != nil {
|
|
log.Warnf("Failed to validate UI banner URL in configmap: %v", err)
|
|
}
|
|
settings.UiBannerURL = argoCDCM.Data[settingUiBannerURLKey]
|
|
if userSessionDurationStr, ok := argoCDCM.Data[userSessionDurationKey]; ok {
|
|
if val, err := timeutil.ParseDuration(userSessionDurationStr); err != nil {
|
|
log.Warnf("Failed to parse '%s' key: %v", userSessionDurationKey, err)
|
|
} else {
|
|
settings.UserSessionDuration = *val
|
|
}
|
|
} else {
|
|
settings.UserSessionDuration = time.Hour * 24
|
|
}
|
|
}
|
|
|
|
// validateExternalURL ensures the external URL that is set on the configmap is valid
|
|
func validateExternalURL(u string) error {
|
|
if u == "" {
|
|
return nil
|
|
}
|
|
URL, err := url.Parse(u)
|
|
if err != nil {
|
|
return fmt.Errorf("Failed to parse URL: %v", err)
|
|
}
|
|
if URL.Scheme != "http" && URL.Scheme != "https" {
|
|
return fmt.Errorf("URL must include http or https protocol")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// updateSettingsFromSecret transfers settings from a Kubernetes secret into an ArgoCDSettings struct.
|
|
func (mgr *SettingsManager) updateSettingsFromSecret(settings *ArgoCDSettings, argoCDSecret *apiv1.Secret) error {
|
|
var errs []error
|
|
secretKey, ok := argoCDSecret.Data[settingServerSignatureKey]
|
|
if ok {
|
|
settings.ServerSignature = secretKey
|
|
} else {
|
|
errs = append(errs, &incompleteSettingsError{message: "server.secretkey is missing"})
|
|
}
|
|
if githubWebhookSecret := argoCDSecret.Data[settingsWebhookGitHubSecretKey]; len(githubWebhookSecret) > 0 {
|
|
settings.WebhookGitHubSecret = string(githubWebhookSecret)
|
|
}
|
|
if gitlabWebhookSecret := argoCDSecret.Data[settingsWebhookGitLabSecretKey]; len(gitlabWebhookSecret) > 0 {
|
|
settings.WebhookGitLabSecret = string(gitlabWebhookSecret)
|
|
}
|
|
if bitbucketWebhookUUID := argoCDSecret.Data[settingsWebhookBitbucketUUIDKey]; len(bitbucketWebhookUUID) > 0 {
|
|
settings.WebhookBitbucketUUID = string(bitbucketWebhookUUID)
|
|
}
|
|
if bitbucketserverWebhookSecret := argoCDSecret.Data[settingsWebhookBitbucketServerSecretKey]; len(bitbucketserverWebhookSecret) > 0 {
|
|
settings.WebhookBitbucketServerSecret = string(bitbucketserverWebhookSecret)
|
|
}
|
|
if gogsWebhookSecret := argoCDSecret.Data[settingsWebhookGogsSecretKey]; len(gogsWebhookSecret) > 0 {
|
|
settings.WebhookGogsSecret = string(gogsWebhookSecret)
|
|
}
|
|
|
|
// The TLS certificate may be externally managed. We try to load it from an
|
|
// external secret first. If the external secret doesn't exist, we either
|
|
// load it from argocd-secret or generate (and persist) a self-signed one.
|
|
cert, err := mgr.externalServerTLSCertificate()
|
|
if err != nil {
|
|
errs = append(errs, &incompleteSettingsError{message: fmt.Sprintf("could not read from secret %s/%s: %v", mgr.namespace, externalServerTLSSecretName, err)})
|
|
} else {
|
|
if cert != nil {
|
|
settings.Certificate = cert
|
|
settings.CertificateIsExternal = true
|
|
log.Infof("Loading TLS configuration from secret %s/%s", mgr.namespace, externalServerTLSSecretName)
|
|
} else {
|
|
serverCert, certOk := argoCDSecret.Data[settingServerCertificate]
|
|
serverKey, keyOk := argoCDSecret.Data[settingServerPrivateKey]
|
|
if certOk && keyOk {
|
|
cert, err := tls.X509KeyPair(serverCert, serverKey)
|
|
if err != nil {
|
|
errs = append(errs, &incompleteSettingsError{message: fmt.Sprintf("invalid x509 key pair %s/%s in secret: %s", settingServerCertificate, settingServerPrivateKey, err)})
|
|
} else {
|
|
settings.Certificate = &cert
|
|
settings.CertificateIsExternal = false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
secretValues := make(map[string]string, len(argoCDSecret.Data))
|
|
for k, v := range argoCDSecret.Data {
|
|
secretValues[k] = string(v)
|
|
}
|
|
settings.Secrets = secretValues
|
|
if len(errs) > 0 {
|
|
return errs[0]
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// externalServerTLSCertificate will try and load a TLS certificate from an
|
|
// external secret, instead of tls.crt and tls.key in argocd-secret. If both
|
|
// return values are nil, no external secret has been configured.
|
|
func (mgr *SettingsManager) externalServerTLSCertificate() (*tls.Certificate, error) {
|
|
var cert tls.Certificate
|
|
secret, err := mgr.clientset.CoreV1().Secrets(mgr.namespace).Get(mgr.ctx, externalServerTLSSecretName, metav1.GetOptions{})
|
|
if err != nil {
|
|
if apierr.IsNotFound(err) {
|
|
return nil, nil
|
|
}
|
|
}
|
|
tlsCert, certOK := secret.Data[settingServerCertificate]
|
|
tlsKey, keyOK := secret.Data[settingServerPrivateKey]
|
|
if certOK && keyOK {
|
|
cert, err = tls.X509KeyPair(tlsCert, tlsKey)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return &cert, nil
|
|
}
|
|
|
|
// SaveSettings serializes ArgoCDSettings and upserts it into K8s secret/configmap
|
|
func (mgr *SettingsManager) SaveSettings(settings *ArgoCDSettings) error {
|
|
err := mgr.updateConfigMap(func(argoCDCM *apiv1.ConfigMap) error {
|
|
if settings.URL != "" {
|
|
argoCDCM.Data[settingURLKey] = settings.URL
|
|
} else {
|
|
delete(argoCDCM.Data, settingURLKey)
|
|
}
|
|
if settings.DexConfig != "" {
|
|
argoCDCM.Data[settingDexConfigKey] = settings.DexConfig
|
|
} else {
|
|
delete(argoCDCM.Data, settings.DexConfig)
|
|
}
|
|
if settings.OIDCConfigRAW != "" {
|
|
argoCDCM.Data[settingsOIDCConfigKey] = settings.OIDCConfigRAW
|
|
} else {
|
|
delete(argoCDCM.Data, settingsOIDCConfigKey)
|
|
}
|
|
if settings.UiCssURL != "" {
|
|
argoCDCM.Data[settingUiCssURLKey] = settings.UiCssURL
|
|
}
|
|
if settings.UiBannerContent != "" {
|
|
argoCDCM.Data[settingUiBannerContentKey] = settings.UiBannerContent
|
|
} else {
|
|
delete(argoCDCM.Data, settingUiBannerContentKey)
|
|
}
|
|
if settings.UiBannerURL != "" {
|
|
argoCDCM.Data[settingUiBannerURLKey] = settings.UiBannerURL
|
|
} else {
|
|
delete(argoCDCM.Data, settingUiBannerURLKey)
|
|
}
|
|
return nil
|
|
})
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = mgr.updateSecret(func(argoCDSecret *apiv1.Secret) error {
|
|
argoCDSecret.Data[settingServerSignatureKey] = settings.ServerSignature
|
|
if settings.WebhookGitHubSecret != "" {
|
|
argoCDSecret.Data[settingsWebhookGitHubSecretKey] = []byte(settings.WebhookGitHubSecret)
|
|
}
|
|
if settings.WebhookGitLabSecret != "" {
|
|
argoCDSecret.Data[settingsWebhookGitLabSecretKey] = []byte(settings.WebhookGitLabSecret)
|
|
}
|
|
if settings.WebhookBitbucketUUID != "" {
|
|
argoCDSecret.Data[settingsWebhookBitbucketUUIDKey] = []byte(settings.WebhookBitbucketUUID)
|
|
}
|
|
if settings.WebhookBitbucketServerSecret != "" {
|
|
argoCDSecret.Data[settingsWebhookBitbucketServerSecretKey] = []byte(settings.WebhookBitbucketServerSecret)
|
|
}
|
|
if settings.WebhookGogsSecret != "" {
|
|
argoCDSecret.Data[settingsWebhookGogsSecretKey] = []byte(settings.WebhookGogsSecret)
|
|
}
|
|
// we only write the certificate to the secret if it's not externally
|
|
// managed.
|
|
if settings.Certificate != nil && !settings.CertificateIsExternal {
|
|
cert, key := tlsutil.EncodeX509KeyPair(*settings.Certificate)
|
|
argoCDSecret.Data[settingServerCertificate] = cert
|
|
argoCDSecret.Data[settingServerPrivateKey] = key
|
|
} else {
|
|
delete(argoCDSecret.Data, settingServerCertificate)
|
|
delete(argoCDSecret.Data, settingServerPrivateKey)
|
|
}
|
|
return nil
|
|
})
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return mgr.ResyncInformers()
|
|
}
|
|
|
|
// Save the SSH known host data into the corresponding ConfigMap
|
|
func (mgr *SettingsManager) SaveSSHKnownHostsData(ctx context.Context, knownHostsList []string) error {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
certCM, err := mgr.GetConfigMapByName(common.ArgoCDKnownHostsConfigMapName)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if certCM.Data == nil {
|
|
certCM.Data = make(map[string]string)
|
|
}
|
|
|
|
sshKnownHostsData := strings.Join(knownHostsList, "\n") + "\n"
|
|
certCM.Data["ssh_known_hosts"] = sshKnownHostsData
|
|
_, err = mgr.clientset.CoreV1().ConfigMaps(mgr.namespace).Update(ctx, certCM, metav1.UpdateOptions{})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return mgr.ResyncInformers()
|
|
}
|
|
|
|
func (mgr *SettingsManager) SaveTLSCertificateData(ctx context.Context, tlsCertificates map[string]string) error {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
certCM, err := mgr.GetConfigMapByName(common.ArgoCDTLSCertsConfigMapName)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
certCM.Data = tlsCertificates
|
|
_, err = mgr.clientset.CoreV1().ConfigMaps(mgr.namespace).Update(ctx, certCM, metav1.UpdateOptions{})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return mgr.ResyncInformers()
|
|
}
|
|
|
|
func (mgr *SettingsManager) SaveGPGPublicKeyData(ctx context.Context, gpgPublicKeys map[string]string) error {
|
|
err := mgr.ensureSynced(false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
keysCM, err := mgr.GetConfigMapByName(common.ArgoCDGPGKeysConfigMapName)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
keysCM.Data = gpgPublicKeys
|
|
_, err = mgr.clientset.CoreV1().ConfigMaps(mgr.namespace).Update(ctx, keysCM, metav1.UpdateOptions{})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return mgr.ResyncInformers()
|
|
|
|
}
|
|
|
|
// NewSettingsManager generates a new SettingsManager pointer and returns it
|
|
func NewSettingsManager(ctx context.Context, clientset kubernetes.Interface, namespace string) *SettingsManager {
|
|
|
|
mgr := &SettingsManager{
|
|
ctx: ctx,
|
|
clientset: clientset,
|
|
namespace: namespace,
|
|
mutex: &sync.Mutex{},
|
|
}
|
|
|
|
return mgr
|
|
}
|
|
|
|
func (mgr *SettingsManager) ResyncInformers() error {
|
|
return mgr.ensureSynced(true)
|
|
}
|
|
|
|
// IsSSOConfigured returns whether or not single-sign-on is configured
|
|
func (a *ArgoCDSettings) IsSSOConfigured() bool {
|
|
if a.IsDexConfigured() {
|
|
return true
|
|
}
|
|
if a.OIDCConfig() != nil {
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (a *ArgoCDSettings) IsDexConfigured() bool {
|
|
if a.URL == "" {
|
|
return false
|
|
}
|
|
dexCfg, err := UnmarshalDexConfig(a.DexConfig)
|
|
if err != nil {
|
|
log.Warn("invalid dex yaml config")
|
|
return false
|
|
}
|
|
return len(dexCfg) > 0
|
|
}
|
|
|
|
func UnmarshalDexConfig(config string) (map[string]interface{}, error) {
|
|
var dexCfg map[string]interface{}
|
|
err := yaml.Unmarshal([]byte(config), &dexCfg)
|
|
return dexCfg, err
|
|
}
|
|
|
|
func (a *ArgoCDSettings) OIDCConfig() *OIDCConfig {
|
|
if a.OIDCConfigRAW == "" {
|
|
return nil
|
|
}
|
|
oidcConfig, err := UnmarshalOIDCConfig(a.OIDCConfigRAW)
|
|
if err != nil {
|
|
log.Warnf("invalid oidc config: %v", err)
|
|
return nil
|
|
}
|
|
oidcConfig.ClientSecret = ReplaceStringSecret(oidcConfig.ClientSecret, a.Secrets)
|
|
oidcConfig.ClientID = ReplaceStringSecret(oidcConfig.ClientID, a.Secrets)
|
|
return &oidcConfig
|
|
}
|
|
|
|
func UnmarshalOIDCConfig(config string) (OIDCConfig, error) {
|
|
var oidcConfig OIDCConfig
|
|
err := yaml.Unmarshal([]byte(config), &oidcConfig)
|
|
return oidcConfig, err
|
|
}
|
|
|
|
// TLSConfig returns a tls.Config with the configured certificates
|
|
func (a *ArgoCDSettings) TLSConfig() *tls.Config {
|
|
if a.Certificate == nil {
|
|
return nil
|
|
}
|
|
certPool := x509.NewCertPool()
|
|
pemCertBytes, _ := tlsutil.EncodeX509KeyPair(*a.Certificate)
|
|
ok := certPool.AppendCertsFromPEM(pemCertBytes)
|
|
if !ok {
|
|
panic("bad certs")
|
|
}
|
|
return &tls.Config{
|
|
RootCAs: certPool,
|
|
}
|
|
}
|
|
|
|
func (a *ArgoCDSettings) IssuerURL() string {
|
|
if oidcConfig := a.OIDCConfig(); oidcConfig != nil {
|
|
return oidcConfig.Issuer
|
|
}
|
|
if a.DexConfig != "" {
|
|
return a.URL + common.DexAPIEndpoint
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func (a *ArgoCDSettings) OAuth2ClientID() string {
|
|
if oidcConfig := a.OIDCConfig(); oidcConfig != nil {
|
|
return oidcConfig.ClientID
|
|
}
|
|
if a.DexConfig != "" {
|
|
return common.ArgoCDClientAppID
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func (a *ArgoCDSettings) OAuth2ClientSecret() string {
|
|
if oidcConfig := a.OIDCConfig(); oidcConfig != nil {
|
|
return oidcConfig.ClientSecret
|
|
}
|
|
if a.DexConfig != "" {
|
|
return a.DexOAuth2ClientSecret()
|
|
}
|
|
return ""
|
|
}
|
|
|
|
func appendURLPath(inputURL string, inputPath string) (string, error) {
|
|
u, err := url.Parse(inputURL)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
u.Path = path.Join(u.Path, inputPath)
|
|
return u.String(), nil
|
|
}
|
|
|
|
func (a *ArgoCDSettings) RedirectURL() (string, error) {
|
|
return appendURLPath(a.URL, common.CallbackEndpoint)
|
|
}
|
|
|
|
func (a *ArgoCDSettings) DexRedirectURL() (string, error) {
|
|
return appendURLPath(a.URL, common.DexCallbackEndpoint)
|
|
}
|
|
|
|
// DexOAuth2ClientSecret calculates an arbitrary, but predictable OAuth2 client secret string derived
|
|
// from the server secret. This is called by the dex startup wrapper (argocd-dex rundex), as well
|
|
// as the API server, such that they both independently come to the same conclusion of what the
|
|
// OAuth2 shared client secret should be.
|
|
func (a *ArgoCDSettings) DexOAuth2ClientSecret() string {
|
|
h := sha256.New()
|
|
_, err := h.Write(a.ServerSignature)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
sha := h.Sum(nil)
|
|
return base64.URLEncoding.EncodeToString(sha)[:40]
|
|
}
|
|
|
|
// Subscribe registers a channel in which to subscribe to settings updates
|
|
func (mgr *SettingsManager) Subscribe(subCh chan<- *ArgoCDSettings) {
|
|
mgr.mutex.Lock()
|
|
defer mgr.mutex.Unlock()
|
|
mgr.subscribers = append(mgr.subscribers, subCh)
|
|
log.Infof("%v subscribed to settings updates", subCh)
|
|
}
|
|
|
|
// Unsubscribe unregisters a channel from receiving of settings updates
|
|
func (mgr *SettingsManager) Unsubscribe(subCh chan<- *ArgoCDSettings) {
|
|
mgr.mutex.Lock()
|
|
defer mgr.mutex.Unlock()
|
|
for i, ch := range mgr.subscribers {
|
|
if ch == subCh {
|
|
mgr.subscribers = append(mgr.subscribers[:i], mgr.subscribers[i+1:]...)
|
|
log.Infof("%v unsubscribed from settings updates", subCh)
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
func (mgr *SettingsManager) notifySubscribers(newSettings *ArgoCDSettings) {
|
|
mgr.mutex.Lock()
|
|
defer mgr.mutex.Unlock()
|
|
if len(mgr.subscribers) > 0 {
|
|
subscribers := make([]chan<- *ArgoCDSettings, len(mgr.subscribers))
|
|
copy(subscribers, mgr.subscribers)
|
|
// make sure subscribes are notified in a separate thread to avoid potential deadlock
|
|
go func() {
|
|
log.Infof("Notifying %d settings subscribers: %v", len(subscribers), subscribers)
|
|
for _, sub := range subscribers {
|
|
sub <- newSettings
|
|
}
|
|
}()
|
|
}
|
|
}
|
|
|
|
func isIncompleteSettingsError(err error) bool {
|
|
_, ok := err.(*incompleteSettingsError)
|
|
return ok
|
|
}
|
|
|
|
// InitializeSettings is used to initialize empty admin password, signature, certificate etc if missing
|
|
func (mgr *SettingsManager) InitializeSettings(insecureModeEnabled bool) (*ArgoCDSettings, error) {
|
|
cdSettings, err := mgr.GetSettings()
|
|
if err != nil && !isIncompleteSettingsError(err) {
|
|
return nil, err
|
|
}
|
|
if cdSettings == nil {
|
|
cdSettings = &ArgoCDSettings{}
|
|
}
|
|
if cdSettings.ServerSignature == nil {
|
|
// set JWT signature
|
|
signature, err := util.MakeSignature(32)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
cdSettings.ServerSignature = signature
|
|
log.Info("Initialized server signature")
|
|
}
|
|
err = mgr.UpdateAccount(common.ArgoCDAdminUsername, func(adminAccount *Account) error {
|
|
if adminAccount.Enabled {
|
|
now := time.Now().UTC()
|
|
if adminAccount.PasswordHash == "" {
|
|
initialPassword := argorand.RandString(initialPasswordLength)
|
|
hashedPassword, err := password.HashPassword(initialPassword)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
ku := kube.NewKubeUtil(mgr.clientset, mgr.ctx)
|
|
err = ku.CreateOrUpdateSecretField(mgr.namespace, initialPasswordSecretName, initialPasswordSecretField, initialPassword)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
adminAccount.PasswordHash = hashedPassword
|
|
adminAccount.PasswordMtime = &now
|
|
log.Info("Initialized admin password")
|
|
}
|
|
if adminAccount.PasswordMtime == nil || adminAccount.PasswordMtime.IsZero() {
|
|
adminAccount.PasswordMtime = &now
|
|
log.Info("Initialized admin mtime")
|
|
}
|
|
} else {
|
|
log.Info("admin disabled")
|
|
}
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if cdSettings.Certificate == nil && !insecureModeEnabled {
|
|
// generate TLS cert
|
|
hosts := []string{
|
|
"localhost",
|
|
"argocd-server",
|
|
fmt.Sprintf("argocd-server.%s", mgr.namespace),
|
|
fmt.Sprintf("argocd-server.%s.svc", mgr.namespace),
|
|
fmt.Sprintf("argocd-server.%s.svc.cluster.local", mgr.namespace),
|
|
}
|
|
certOpts := tlsutil.CertOptions{
|
|
Hosts: hosts,
|
|
Organization: "Argo CD",
|
|
IsCA: true,
|
|
}
|
|
cert, err := tlsutil.GenerateX509KeyPair(certOpts)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
cdSettings.Certificate = cert
|
|
log.Info("Initialized TLS certificate")
|
|
}
|
|
|
|
err = mgr.SaveSettings(cdSettings)
|
|
if apierrors.IsConflict(err) {
|
|
// assume settings are initialized by another instance of api server
|
|
log.Warnf("conflict when initializing settings. assuming updated by another replica")
|
|
return mgr.GetSettings()
|
|
}
|
|
return cdSettings, nil
|
|
}
|
|
|
|
// ReplaceStringSecret checks if given string is a secret key reference ( starts with $ ) and returns corresponding value from provided map
|
|
func ReplaceStringSecret(val string, secretValues map[string]string) string {
|
|
if val == "" || !strings.HasPrefix(val, "$") {
|
|
return val
|
|
}
|
|
secretKey := val[1:]
|
|
secretVal, ok := secretValues[secretKey]
|
|
if !ok {
|
|
log.Warnf("config referenced '%s', but key does not exist in secret", val)
|
|
return val
|
|
}
|
|
return strings.TrimSpace(secretVal)
|
|
}
|
|
|
|
// GetGlobalProjectsSettings loads the global project settings from argocd-cm ConfigMap
|
|
func (mgr *SettingsManager) GetGlobalProjectsSettings() ([]GlobalProjectSettings, error) {
|
|
argoCDCM, err := mgr.getConfigMap()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
globalProjectSettings := make([]GlobalProjectSettings, 0)
|
|
if value, ok := argoCDCM.Data[globalProjectsKey]; ok {
|
|
if value != "" {
|
|
err := yaml.Unmarshal([]byte(value), &globalProjectSettings)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
}
|
|
return globalProjectSettings, nil
|
|
}
|