argocd

Documentation

Index

• func AddSeccompProfileForOpenShift(client client.Client, podspec *corev1.PodSpec)
• func GenerateUniqueResourceName(argoComponentName string, cr *argoprojv1a1.ArgoCD) string
• func InspectCluster() error
• func IsPrometheusAPIAvailable() bool
• func IsRouteAPIAvailable() bool
• func IsTemplateAPIAvailable() bool
• func IsVersionAPIAvailable() bool
• func Register(h ...Hook)
• func ZapLogger(development bool) logr.Logger
• type CustomKeycloakAPIRealm
• type DexConnector
• type GrafanaConfig
• type GrafanaSecurityConfig
• type Hook
• type KeycloakIdentityProviderMapper
• type ReconcileArgoCD
  • func (r *ReconcileArgoCD) Reconcile(ctx context.Context, request ctrl.Request) (ctrl.Result, error)
  • func (r *ReconcileArgoCD) SetupWithManager(mgr ctrl.Manager) error

Functions

func AddSeccompProfileForOpenShift

func AddSeccompProfileForOpenShift(client client.Client, podspec *corev1.PodSpec)

func GenerateUniqueResourceName

func GenerateUniqueResourceName(argoComponentName string, cr *argoprojv1a1.ArgoCD) string

GenerateUniqueResourceName generates unique names for cluster scoped resources

func InspectCluster

func InspectCluster() error

InspectCluster will verify the availability of extra features available to the cluster, such as Prometheus and OpenShift Routes.

func IsPrometheusAPIAvailable

func IsPrometheusAPIAvailable() bool

IsPrometheusAPIAvailable returns true if the Prometheus API is present.

func IsRouteAPIAvailable

func IsRouteAPIAvailable() bool

IsRouteAPIAvailable returns true if the Route API is present.

func IsTemplateAPIAvailable

func IsTemplateAPIAvailable() bool

IsTemplateAPIAvailable returns true if the template API is present.

func IsVersionAPIAvailable

func IsVersionAPIAvailable() bool

IsVersionAPIAvailable returns true if the version api is present

func Register

func Register(h ...Hook)

Register adds a modifier for updating resources during reconciliation.

func ZapLogger

func ZapLogger(development bool) logr.Logger

Types

type CustomKeycloakAPIRealm

type CustomKeycloakAPIRealm struct {
	// Realm name.
	Realm string `json:"realm"`
	// Realm enabled flag.
	// +optional
	Enabled bool `json:"enabled"`
	// Require SSL
	// +optional
	SslRequired string `json:"sslRequired,omitempty"`
	// A set of Keycloak Clients.
	// +optional
	Clients []*keycloakv1alpha1.KeycloakAPIClient `json:"clients,omitempty"`
	// Client scopes
	// +optional
	ClientScopes []keycloakv1alpha1.KeycloakClientScope `json:"clientScopes,omitempty"`
	// A set of Identity Providers.
	// +optional
	IdentityProviders []*keycloakv1alpha1.KeycloakIdentityProvider `json:"identityProviders,omitempty"`
	// KeycloakIdentityProviderMapper defines IdentityProvider Mappers
	// issue: https://github.com/keycloak/keycloak-operator/issues/471
	IdentityProviderMappers []*KeycloakIdentityProviderMapper `json:"identityProviderMappers,omitempty"`
}

CustomKeycloakAPIRealm is an extention type of KeycloakAPIRealm as is it does not support IdentityProvider Mappers issue: https://github.com/keycloak/keycloak-operator/issues/471

type DexConnector

type DexConnector struct {
	Config map[string]interface{} `yaml:"config,omitempty"`
	ID     string                 `yaml:"id"`
	Name   string                 `yaml:"name"`
	Type   string                 `yaml:"type"`
}

DexConnector represents an authentication connector for Dex.

type GrafanaConfig

type GrafanaConfig struct {
	// Security options
	Security GrafanaSecurityConfig
}

GrafanaConfig represents the Grafana configuration options.

type GrafanaSecurityConfig

type GrafanaSecurityConfig struct {
	// AdminUser is the default admin user.
	AdminUser string

	// AdminPassword is the default admin password
	AdminPassword string

	// SecretKey is used for signing
	SecretKey string
}

GrafanaSecurityConfig represents the Grafana security options.

type Hook

type Hook func(*argoprojv1alpha1.ArgoCD, interface{}, string) error

Hook changes resources as they are created or updated by the reconciler.

type KeycloakIdentityProviderMapper

type KeycloakIdentityProviderMapper struct {
	// Name
	// +optional
	Name string `json:"name,omitempty"`
	// Identity Provider Alias.
	// +optional
	IdentityProviderAlias string `json:"identityProviderAlias,omitempty"`
	// Identity Provider Mapper.
	// +optional
	IdentityProviderMapper string `json:"identityProviderMapper,omitempty"`
	// Identity Provider Mapper config.
	// +optional
	Config map[string]string `json:"config,omitempty"`
}

KeycloakIdentityProviderMapper defines IdentityProvider Mappers issue: https://github.com/keycloak/keycloak-operator/issues/471

type ReconcileArgoCD

type ReconcileArgoCD struct {
	client.Client
	Scheme            *runtime.Scheme
	ManagedNamespaces *corev1.NamespaceList
}

ArgoCDReconciler reconciles a ArgoCD object TODO(upgrade): rename to ArgoCDRecoonciler

func (*ReconcileArgoCD) Reconcile

func (r *ReconcileArgoCD) Reconcile(ctx context.Context, request ctrl.Request) (ctrl.Result, error)

Reconcile is part of the main kubernetes reconciliation loop which aims to move the current state of the cluster closer to the desired state. the ArgoCD object against the actual cluster state, and then perform operations to make the cluster state reflect the state specified by the user.

For more details, check Reconcile and its Result here: - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.9.2/pkg/reconcile

func (*ReconcileArgoCD) SetupWithManager

func (r *ReconcileArgoCD) SetupWithManager(mgr ctrl.Manager) error

SetupWithManager sets up the controller with the Manager.