utils

package
v0.0.0-...-a02f5d2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 2, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const (
	URL = "https://github.com/kubernetes/ingress-nginx/tree/main/"
)

Variables

View Source
var DEBUG bool

Functions

func CheckArgs

func CheckArgs(arg ...string)

CheckArgs should be used to ensure the right command line arguments are passed before executing an example.

func CheckIfError

func CheckIfError(err error, format string, args ...interface{})

CheckIfError should be used to naively panics if an error is not nil.

func Debug

func Debug(format string, args ...interface{})

Info should be used to describe the example commands that are about to run.

func DownloadFile

func DownloadFile(url string) (string, error)

func ErrorF

func ErrorF(format string, args ...interface{})

Info should be used to describe the example commands that are about to run.

func FindImageDigest

func FindImageDigest(yaml ImageYamls, image, version string) string

func GenerateE2EDocs

func GenerateE2EDocs() (string, error)

func Info

func Info(format string, args ...interface{})

Info should be used to describe the example commands that are about to run.

func Warning

func Warning(format string, args ...interface{})

Warning should be used to display a warning

Types

type ControllerImage

type ControllerImage struct {
	Tag      string
	Digest   string
	Registry string
	Name     string
}

ControllerImage - struct with info about controllers

type E2ETemplate

type E2ETemplate struct {
	URL   string
	Tests []string
}

type ImageElement

type ImageElement struct {
	Name string              `json:"name"`
	Dmap map[string][]string `json:"dmap"`
}

ImageElement - a specific image and it's data structure the dmap is a list of shas and container versions

type ImageYamls

type ImageYamls []ImageElement

IMAGES_YAML returns this data structure

type IngressChartValue

type IngressChartValue struct {
	CommonLabels struct{} `yaml:"commonLabels"`
	Controller   struct {
		Name  string `yaml:"name"`
		Image struct {
			Chroot                   bool   `yaml:"chroot"`
			Registry                 string `yaml:"registry"`
			Image                    string `yaml:"image"`
			Tag                      string `yaml:"tag"`
			Digest                   string `yaml:"digest"`
			DigestChroot             string `yaml:"digestChroot"`
			PullPolicy               string `yaml:"pullPolicy"`
			RunAsUser                int    `yaml:"runAsUser"`
			AllowPrivilegeEscalation bool   `yaml:"allowPrivilegeEscalation"`
		} `yaml:"image"`
		ExistingPsp   string `yaml:"existingPsp"`
		ContainerName string `yaml:"containerName"`
		ContainerPort struct {
			HTTP  int `yaml:"http"`
			HTTPS int `yaml:"https"`
		} `yaml:"containerPort"`
		Config                   struct{} `yaml:"config"`
		ConfigAnnotations        struct{} `yaml:"configAnnotations"`
		ProxySetHeaders          struct{} `yaml:"proxySetHeaders"`
		AddHeaders               struct{} `yaml:"addHeaders"`
		DNSConfig                struct{} `yaml:"dnsConfig"`
		Hostname                 struct{} `yaml:"hostname"`
		DNSPolicy                string   `yaml:"dnsPolicy"`
		ReportNodeInternalIP     bool     `yaml:"reportNodeInternalIp"`
		WatchIngressWithoutClass bool     `yaml:"watchIngressWithoutClass"`
		IngressClassByName       bool     `yaml:"ingressClassByName"`
		AllowSnippetAnnotations  bool     `yaml:"allowSnippetAnnotations"`
		HostNetwork              bool     `yaml:"hostNetwork"`
		HostPort                 struct {
			Enabled bool `yaml:"enabled"`
			Ports   struct {
				HTTP  int `yaml:"http"`
				HTTPS int `yaml:"https"`
			} `yaml:"ports"`
		} `yaml:"hostPort"`
		ElectionID           string `yaml:"electionID"`
		IngressClassResource struct {
			Name            string   `yaml:"name"`
			Enabled         bool     `yaml:"enabled"`
			Default         bool     `yaml:"default"`
			ControllerValue string   `yaml:"controllerValue"`
			Parameters      struct{} `yaml:"parameters"`
		} `yaml:"ingressClassResource"`
		IngressClass       string   `yaml:"ingressClass"`
		PodLabels          struct{} `yaml:"podLabels"`
		PodSecurityContext struct{} `yaml:"podSecurityContext"`
		Sysctls            struct{} `yaml:"sysctls"`
		PublishService     struct {
			Enabled      bool   `yaml:"enabled"`
			PathOverride string `yaml:"pathOverride"`
		} `yaml:"publishService"`
		Scope struct {
			Enabled           bool   `yaml:"enabled"`
			Namespace         string `yaml:"namespace"`
			NamespaceSelector string `yaml:"namespaceSelector"`
		} `yaml:"scope"`
		ConfigMapNamespace string `yaml:"configMapNamespace"`
		TCP                struct {
			ConfigMapNamespace string   `yaml:"configMapNamespace"`
			Annotations        struct{} `yaml:"annotations"`
		} `yaml:"tcp"`
		UDP struct {
			ConfigMapNamespace string   `yaml:"configMapNamespace"`
			Annotations        struct{} `yaml:"annotations"`
		} `yaml:"udp"`
		MaxmindLicenseKey             string        `yaml:"maxmindLicenseKey"`
		ExtraArgs                     struct{}      `yaml:"extraArgs"`
		ExtraEnvs                     []interface{} `yaml:"extraEnvs"`
		Kind                          string        `yaml:"kind"`
		Annotations                   struct{}      `yaml:"annotations"`
		Labels                        struct{}      `yaml:"labels"`
		UpdateStrategy                struct{}      `yaml:"updateStrategy"`
		MinReadySeconds               int           `yaml:"minReadySeconds"`
		Tolerations                   []interface{} `yaml:"tolerations"`
		Affinity                      struct{}      `yaml:"affinity"`
		TopologySpreadConstraints     []interface{} `yaml:"topologySpreadConstraints"`
		TerminationGracePeriodSeconds int           `yaml:"terminationGracePeriodSeconds"`
		NodeSelector                  struct {
			KubernetesIoOs string `yaml:"kubernetes.io/os"`
		} `yaml:"nodeSelector"`
		LivenessProbe struct {
			HTTPGet struct {
				Path   string `yaml:"path"`
				Port   int    `yaml:"port"`
				Scheme string `yaml:"scheme"`
			} `yaml:"httpGet"`
			InitialDelaySeconds int `yaml:"initialDelaySeconds"`
			PeriodSeconds       int `yaml:"periodSeconds"`
			TimeoutSeconds      int `yaml:"timeoutSeconds"`
			SuccessThreshold    int `yaml:"successThreshold"`
			FailureThreshold    int `yaml:"failureThreshold"`
		} `yaml:"livenessProbe"`
		ReadinessProbe struct {
			HTTPGet struct {
				Path   string `yaml:"path"`
				Port   int    `yaml:"port"`
				Scheme string `yaml:"scheme"`
			} `yaml:"httpGet"`
			InitialDelaySeconds int `yaml:"initialDelaySeconds"`
			PeriodSeconds       int `yaml:"periodSeconds"`
			TimeoutSeconds      int `yaml:"timeoutSeconds"`
			SuccessThreshold    int `yaml:"successThreshold"`
			FailureThreshold    int `yaml:"failureThreshold"`
		} `yaml:"readinessProbe"`
		HealthCheckPath string   `yaml:"healthCheckPath"`
		HealthCheckHost string   `yaml:"healthCheckHost"`
		PodAnnotations  struct{} `yaml:"podAnnotations"`
		ReplicaCount    int      `yaml:"replicaCount"`
		MinAvailable    int      `yaml:"minAvailable"`
		Resources       struct {
			Requests struct {
				CPU    string `yaml:"cpu"`
				Memory string `yaml:"memory"`
			} `yaml:"requests"`
		} `yaml:"resources"`
		Autoscaling struct {
			APIVersion                        string   `yaml:"apiVersion"`
			Enabled                           bool     `yaml:"enabled"`
			Annotations                       struct{} `yaml:"annotations"`
			MinReplicas                       int      `yaml:"minReplicas"`
			MaxReplicas                       int      `yaml:"maxReplicas"`
			TargetCPUUtilizationPercentage    int      `yaml:"targetCPUUtilizationPercentage"`
			TargetMemoryUtilizationPercentage int      `yaml:"targetMemoryUtilizationPercentage"`
			Behavior                          struct{} `yaml:"behavior"`
		} `yaml:"autoscaling"`
		AutoscalingTemplate []interface{} `yaml:"autoscalingTemplate"`
		Keda                struct {
			APIVersion                    string `yaml:"apiVersion"`
			Enabled                       bool   `yaml:"enabled"`
			MinReplicas                   int    `yaml:"minReplicas"`
			MaxReplicas                   int    `yaml:"maxReplicas"`
			PollingInterval               int    `yaml:"pollingInterval"`
			CooldownPeriod                int    `yaml:"cooldownPeriod"`
			RestoreToOriginalReplicaCount bool   `yaml:"restoreToOriginalReplicaCount"`
			ScaledObject                  struct {
				Annotations struct{} `yaml:"annotations"`
			} `yaml:"scaledObject"`
			Triggers []interface{} `yaml:"triggers"`
			Behavior struct{}      `yaml:"behavior"`
		} `yaml:"keda"`
		EnableMimalloc bool `yaml:"enableMimalloc"`
		CustomTemplate struct {
			ConfigMapName string `yaml:"configMapName"`
			ConfigMapKey  string `yaml:"configMapKey"`
		} `yaml:"customTemplate"`
		Service struct {
			Enabled                  bool          `yaml:"enabled"`
			AppProtocol              bool          `yaml:"appProtocol"`
			Annotations              struct{}      `yaml:"annotations"`
			Labels                   struct{}      `yaml:"labels"`
			ExternalIPs              []interface{} `yaml:"externalIPs"`
			LoadBalancerIP           string        `yaml:"loadBalancerIP"`
			LoadBalancerSourceRanges []interface{} `yaml:"loadBalancerSourceRanges"`
			EnableHTTP               bool          `yaml:"enableHttp"`
			EnableHTTPS              bool          `yaml:"enableHttps"`
			IPFamilyPolicy           string        `yaml:"ipFamilyPolicy"`
			IPFamilies               []string      `yaml:"ipFamilies"`
			Ports                    struct {
				HTTP  int `yaml:"http"`
				HTTPS int `yaml:"https"`
			} `yaml:"ports"`
			TargetPorts struct {
				HTTP  string `yaml:"http"`
				HTTPS string `yaml:"https"`
			} `yaml:"targetPorts"`
			Type      string `yaml:"type"`
			NodePorts struct {
				HTTP  string   `yaml:"http"`
				HTTPS string   `yaml:"https"`
				TCP   struct{} `yaml:"tcp"`
				UDP   struct{} `yaml:"udp"`
			} `yaml:"nodePorts"`
			External struct {
				Enabled bool `yaml:"enabled"`
			} `yaml:"external"`
			Internal struct {
				Enabled                  bool          `yaml:"enabled"`
				Annotations              struct{}      `yaml:"annotations"`
				LoadBalancerSourceRanges []interface{} `yaml:"loadBalancerSourceRanges"`
			} `yaml:"internal"`
		} `yaml:"service"`
		ShareProcessNamespace bool          `yaml:"shareProcessNamespace"`
		ExtraContainers       []interface{} `yaml:"extraContainers"`
		ExtraVolumeMounts     []interface{} `yaml:"extraVolumeMounts"`
		ExtraVolumes          []interface{} `yaml:"extraVolumes"`
		ExtraInitContainers   []interface{} `yaml:"extraInitContainers"`
		ExtraModules          []interface{} `yaml:"extraModules"`
		Opentelemetry         struct {
			Enabled                  bool   `yaml:"enabled"`
			Image                    string `yaml:"image"`
			ContainerSecurityContext struct {
				AllowPrivilegeEscalation bool `yaml:"allowPrivilegeEscalation"`
			} `yaml:"containerSecurityContext"`
		} `yaml:"opentelemetry"`
		AdmissionWebhooks struct {
			Annotations          struct{}      `yaml:"annotations"`
			Enabled              bool          `yaml:"enabled"`
			ExtraEnvs            []interface{} `yaml:"extraEnvs"`
			FailurePolicy        string        `yaml:"failurePolicy"`
			Port                 int           `yaml:"port"`
			Certificate          string        `yaml:"certificate"`
			Key                  string        `yaml:"key"`
			NamespaceSelector    struct{}      `yaml:"namespaceSelector"`
			ObjectSelector       struct{}      `yaml:"objectSelector"`
			Labels               struct{}      `yaml:"labels"`
			ExistingPsp          string        `yaml:"existingPsp"`
			NetworkPolicyEnabled bool          `yaml:"networkPolicyEnabled"`
			Service              struct {
				Annotations              struct{}      `yaml:"annotations"`
				ExternalIPs              []interface{} `yaml:"externalIPs"`
				LoadBalancerSourceRanges []interface{} `yaml:"loadBalancerSourceRanges"`
				ServicePort              int           `yaml:"servicePort"`
				Type                     string        `yaml:"type"`
			} `yaml:"service"`
			CreateSecretJob struct {
				SecurityContext struct {
					AllowPrivilegeEscalation bool `yaml:"allowPrivilegeEscalation"`
				} `yaml:"securityContext"`
				Resources struct{} `yaml:"resources"`
			} `yaml:"createSecretJob"`
			PatchWebhookJob struct {
				SecurityContext struct {
					AllowPrivilegeEscalation bool `yaml:"allowPrivilegeEscalation"`
				} `yaml:"securityContext"`
				Resources struct{} `yaml:"resources"`
			} `yaml:"patchWebhookJob"`
			Patch struct {
				Enabled bool `yaml:"enabled"`
				Image   struct {
					Registry   string `yaml:"registry"`
					Image      string `yaml:"image"`
					Tag        string `yaml:"tag"`
					Digest     string `yaml:"digest"`
					PullPolicy string `yaml:"pullPolicy"`
				} `yaml:"image"`
				PriorityClassName string   `yaml:"priorityClassName"`
				PodAnnotations    struct{} `yaml:"podAnnotations"`
				NodeSelector      struct {
					KubernetesIoOs string `yaml:"kubernetes.io/os"`
				} `yaml:"nodeSelector"`
				Tolerations     []interface{} `yaml:"tolerations"`
				Labels          struct{}      `yaml:"labels"`
				SecurityContext struct {
					RunAsNonRoot bool `yaml:"runAsNonRoot"`
					RunAsUser    int  `yaml:"runAsUser"`
					FsGroup      int  `yaml:"fsGroup"`
				} `yaml:"securityContext"`
			} `yaml:"patch"`
			CertManager struct {
				Enabled  bool `yaml:"enabled"`
				RootCert struct {
					Duration string `yaml:"duration"`
				} `yaml:"rootCert"`
				AdmissionCert struct {
					Duration string `yaml:"duration"`
				} `yaml:"admissionCert"`
			} `yaml:"certManager"`
		} `yaml:"admissionWebhooks"`
		Metrics struct {
			Port     int    `yaml:"port"`
			PortName string `yaml:"portName"`
			Enabled  bool   `yaml:"enabled"`
			Service  struct {
				Annotations              struct{}      `yaml:"annotations"`
				ExternalIPs              []interface{} `yaml:"externalIPs"`
				LoadBalancerSourceRanges []interface{} `yaml:"loadBalancerSourceRanges"`
				ServicePort              int           `yaml:"servicePort"`
				Type                     string        `yaml:"type"`
			} `yaml:"service"`
			ServiceMonitor struct {
				Enabled           bool          `yaml:"enabled"`
				AdditionalLabels  struct{}      `yaml:"additionalLabels"`
				Namespace         string        `yaml:"namespace"`
				NamespaceSelector struct{}      `yaml:"namespaceSelector"`
				ScrapeInterval    string        `yaml:"scrapeInterval"`
				TargetLabels      []interface{} `yaml:"targetLabels"`
				Relabelings       []interface{} `yaml:"relabelings"`
				MetricRelabelings []interface{} `yaml:"metricRelabelings"`
			} `yaml:"serviceMonitor"`
			PrometheusRule struct {
				Enabled          bool          `yaml:"enabled"`
				AdditionalLabels struct{}      `yaml:"additionalLabels"`
				Rules            []interface{} `yaml:"rules"`
			} `yaml:"prometheusRule"`
		} `yaml:"metrics"`
		Lifecycle struct {
			PreStop struct {
				Exec struct {
					Command []string `yaml:"command"`
				} `yaml:"exec"`
			} `yaml:"preStop"`
		} `yaml:"lifecycle"`
		PriorityClassName string `yaml:"priorityClassName"`
	} `yaml:"controller"`
	RevisionHistoryLimit int `yaml:"revisionHistoryLimit"`
	DefaultBackend       struct {
		Enabled bool   `yaml:"enabled"`
		Name    string `yaml:"name"`
		Image   struct {
			Registry                 string `yaml:"registry"`
			Image                    string `yaml:"image"`
			Tag                      string `yaml:"tag"`
			PullPolicy               string `yaml:"pullPolicy"`
			RunAsUser                int    `yaml:"runAsUser"`
			RunAsNonRoot             bool   `yaml:"runAsNonRoot"`
			ReadOnlyRootFilesystem   bool   `yaml:"readOnlyRootFilesystem"`
			AllowPrivilegeEscalation bool   `yaml:"allowPrivilegeEscalation"`
		} `yaml:"image"`
		ExistingPsp    string   `yaml:"existingPsp"`
		ExtraArgs      struct{} `yaml:"extraArgs"`
		ServiceAccount struct {
			Create                       bool   `yaml:"create"`
			Name                         string `yaml:"name"`
			AutomountServiceAccountToken bool   `yaml:"automountServiceAccountToken"`
		} `yaml:"serviceAccount"`
		ExtraEnvs     []interface{} `yaml:"extraEnvs"`
		Port          int           `yaml:"port"`
		LivenessProbe struct {
			FailureThreshold    int `yaml:"failureThreshold"`
			InitialDelaySeconds int `yaml:"initialDelaySeconds"`
			PeriodSeconds       int `yaml:"periodSeconds"`
			SuccessThreshold    int `yaml:"successThreshold"`
			TimeoutSeconds      int `yaml:"timeoutSeconds"`
		} `yaml:"livenessProbe"`
		ReadinessProbe struct {
			FailureThreshold    int `yaml:"failureThreshold"`
			InitialDelaySeconds int `yaml:"initialDelaySeconds"`
			PeriodSeconds       int `yaml:"periodSeconds"`
			SuccessThreshold    int `yaml:"successThreshold"`
			TimeoutSeconds      int `yaml:"timeoutSeconds"`
		} `yaml:"readinessProbe"`
		Tolerations              []interface{} `yaml:"tolerations"`
		Affinity                 struct{}      `yaml:"affinity"`
		PodSecurityContext       struct{}      `yaml:"podSecurityContext"`
		ContainerSecurityContext struct{}      `yaml:"containerSecurityContext"`
		PodLabels                struct{}      `yaml:"podLabels"`
		NodeSelector             struct {
			KubernetesIoOs string `yaml:"kubernetes.io/os"`
		} `yaml:"nodeSelector"`
		PodAnnotations    struct{}      `yaml:"podAnnotations"`
		ReplicaCount      int           `yaml:"replicaCount"`
		MinAvailable      int           `yaml:"minAvailable"`
		Resources         struct{}      `yaml:"resources"`
		ExtraVolumeMounts []interface{} `yaml:"extraVolumeMounts"`
		ExtraVolumes      []interface{} `yaml:"extraVolumes"`
		Autoscaling       struct {
			Annotations                       struct{} `yaml:"annotations"`
			Enabled                           bool     `yaml:"enabled"`
			MinReplicas                       int      `yaml:"minReplicas"`
			MaxReplicas                       int      `yaml:"maxReplicas"`
			TargetCPUUtilizationPercentage    int      `yaml:"targetCPUUtilizationPercentage"`
			TargetMemoryUtilizationPercentage int      `yaml:"targetMemoryUtilizationPercentage"`
		} `yaml:"autoscaling"`
		Service struct {
			Annotations              struct{}      `yaml:"annotations"`
			ExternalIPs              []interface{} `yaml:"externalIPs"`
			LoadBalancerSourceRanges []interface{} `yaml:"loadBalancerSourceRanges"`
			ServicePort              int           `yaml:"servicePort"`
			Type                     string        `yaml:"type"`
		} `yaml:"service"`
		PriorityClassName string   `yaml:"priorityClassName"`
		Labels            struct{} `yaml:"labels"`
	} `yaml:"defaultBackend"`
	Rbac struct {
		Create bool `yaml:"create"`
		Scope  bool `yaml:"scope"`
	} `yaml:"rbac"`
	PodSecurityPolicy struct {
		Enabled bool `yaml:"enabled"`
	} `yaml:"podSecurityPolicy"`
	ServiceAccount struct {
		Create                       bool     `yaml:"create"`
		Name                         string   `yaml:"name"`
		AutomountServiceAccountToken bool     `yaml:"automountServiceAccountToken"`
		Annotations                  struct{} `yaml:"annotations"`
	} `yaml:"serviceAccount"`
	ImagePullSecrets []interface{} `yaml:"imagePullSecrets"`
	TCP              struct{}      `yaml:"tcp"`
	UDP              struct{}      `yaml:"udp"`
	PortNamePrefix   string        `yaml:"portNamePrefix"`
	DhParam          interface{}   `yaml:"dhParam"`
}

type IngressRelease

type IngressRelease struct {
	ControllerVersion string
	ControllerImage   ControllerImage
	ReleaseNote       ReleaseNote
	Release           *github.RepositoryRelease
}

IngressRelease All the information about an ingress-nginx release that gets updated

type ReleaseNote

type ReleaseNote struct {
	Version                   string
	NewControllerVersion      string
	PreviousControllerVersion string
	ControllerImages          []ControllerImage
	DepUpdates                []string
	Updates                   []string
	HelmUpdates               []string
	NewHelmChartVersion       string
	PreviousHelmChartVersion  string
}

ReleaseNote - All the pieces of information/documents that get updated during a release

func (ReleaseNote) HelmTemplate

func (r ReleaseNote) HelmTemplate()

func (ReleaseNote) PrintRelease

func (r ReleaseNote) PrintRelease()

func (ReleaseNote) Template

func (r ReleaseNote) Template()

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL