naisjob_doc_example.go

package nais_io_v1

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func ExampleNaisjobForDocumentation() *Naisjob {
	intp := func(i int) *int {
		return &i
	}
	int32p := func(i int32) *int32 {
		return &i
	}
	int64p := func(i int64) *int64 {
		return &i
	}
	boolp := func(b bool) *bool {
		return &b
	}
	stringp := func(s string) *string {
		return &s
	}

	return &Naisjob{
		TypeMeta: metav1.TypeMeta{
			Kind:       "Naisjob",
			APIVersion: "nais.io/v1",
		},
		ObjectMeta: metav1.ObjectMeta{
			Name:      "myjob",
			Namespace: "myteam",
			Labels: map[string]string{
				"team": "myteam",
			},
		},
		Spec: NaisjobSpec{
			AccessPolicy: &AccessPolicy{
				Inbound: &AccessPolicyInbound{
					Rules: []AccessPolicyInboundRule{
						{
							AccessPolicyRule: AccessPolicyRule{
								Application: "app1",
							},
						},
						{
							AccessPolicyRule: AccessPolicyRule{
								Application: "app2",
								Namespace:   "q1",
							},
						},
						{
							AccessPolicyRule: AccessPolicyRule{
								Application: "app3",
								Namespace:   "q2",
								Cluster:     "dev-gcp",
							},
						},
						{
							AccessPolicyRule: AccessPolicyRule{
								Application: "*",
								Namespace:   "q3",
							},
						},
						{
							AccessPolicyRule: AccessPolicyRule{
								Application: "app4",
							},
							Permissions: &AccessPolicyPermissions{
								Scopes: []AccessPolicyPermission{"custom-scope"},
							},
						},
						{
							AccessPolicyRule: AccessPolicyRule{
								Application: "app5",
							},
							Permissions: &AccessPolicyPermissions{
								Roles: []AccessPolicyPermission{"custom-role"},
							},
						},
						{
							AccessPolicyRule: AccessPolicyRule{
								Application: "app6",
							},
							Permissions: &AccessPolicyPermissions{
								Scopes: []AccessPolicyPermission{"custom-scope"},
								Roles:  []AccessPolicyPermission{"custom-role"},
							},
						},
					},
				},
				Outbound: &AccessPolicyOutbound{
					Rules: []AccessPolicyRule{
						{
							Application: "app1",
						},
						{
							Application: "app2",
							Namespace:   "q1",
						},
						{
							Application: "app3",
							Namespace:   "q2",
							Cluster:     "dev-gcp",
						},
						{
							Application: "*",
							Namespace:   "q3",
						},
					},
					External: []AccessPolicyExternalRule{
						{
							Host: "external-application.example.com",
							IPv4: "",
						},
						{
							Host: "non-http-service.example.com",
							IPv4: "",
							Ports: []AccessPolicyPortRule{
								{
									Port: 9200,
								},
							},
						},
					},
				},
			},
			ActiveDeadlineSeconds: int64p(60),
			Azure: &AzureNaisJob{
				Application: &AzureApplication{
					Enabled:       true,
					AllowAllUsers: boolp(true),
					Claims: &AzureAdClaims{
						Groups: []AzureAdGroup{
							{
								ID: "00000000-0000-0000-0000-000000000000",
							},
						},
					},
				},
			},
			BackoffLimit: 5,
			Command: []string{
				"/app/myapplication",
				"--param",
				"value",
				"--other-param",
				"other-value",
			},
			Completions:       int32p(1),
			ConcurrencyPolicy: "Allow",
			Env: []EnvVar{
				{
					Name:  "MY_CUSTOM_VAR",
					Value: "some_value",
				},
				{
					Name: "MY_APPLICATION_NAME",
					ValueFrom: &EnvVarSource{
						FieldRef: ObjectFieldSelector{
							FieldPath: "metadata.name",
						},
					},
				},
			},
			EnvFrom: []EnvFrom{
				{
					Secret: "my-secret-with-envs",
				},
				{
					ConfigMap: "my-configmap-with-envs",
				},
			},
			FailedJobsHistoryLimit: 2,
			FilesFrom: []FilesFrom{
				{
					ConfigMap: "example-files-configmap",
					MountPath: "/var/run/configmaps",
				},
				{
					Secret:    "my-secret-file",
					MountPath: "/var/run/secrets",
				},
				{
					EmptyDir: &EmptyDir{
						Medium: "Memory",
					},
					MountPath: "/var/cache",
				},
				{
					PersistentVolumeClaim: "pvc-name",
					MountPath:             "/var/run/pvc",
				},
			},
			GCP: &GCP{
				BigQueryDatasets: []CloudBigQueryDataset{
					{
						Name:            "my_bigquery_dataset1",
						CascadingDelete: true,
						Description:     "Contains big data, supporting big queries, for use in big ideas.",
						Permission:      BigQueryPermissionReadWrite,
					},
					{
						Name:        "my_bigquery_dataset2",
						Description: "Contains big data, supporting big queries, for use in big ideas.",
						Permission:  BigQueryPermissionRead,
					},
				},
				Buckets: []CloudStorageBucket{
					{
						Name:                "my-cloud-storage-bucket",
						CascadingDelete:     true,
						RetentionPeriodDays: intp(30),
						LifecycleCondition: &LifecycleCondition{
							Age:              10,
							CreatedBefore:    "2020-01-01",
							NumNewerVersions: 2,
							WithState:        "ARCHIVED",
						},
						UniformBucketLevelAccess: true,
						PublicAccessPrevention:   true,
					},
				},
				SqlInstances: []CloudSqlInstance{
					{
						Type:                        "POSTGRES_12",
						Name:                        "myinstance",
						Tier:                        "db-f1-micro",
						DiskType:                    "SSD",
						HighAvailability:            true,
						DiskSize:                    30,
						DiskAutoresize:              true,
						DiskAutoresizeLimit:         60,
						AutoBackupHour:              intp(1),
						RetainedBackups:             intp(14),
						TransactionLogRetentionDays: intp(3),
						Maintenance: &Maintenance{
							Day:  1,
							Hour: intp(4),
						},
						Flags: []CloudSqlFlag{
							{
								Name:  "max_connections",
								Value: "50",
							},
						},
						Databases: []CloudSqlDatabase{
							{
								Name:         "mydatabase",
								EnvVarPrefix: "DB",
								Users: []CloudSqlDatabaseUser{
									{
										Name: "extra_user",
									},
								},
							},
						},
						CascadingDelete:     true,
						Collation:           "nb_NO.UTF8",
						PointInTimeRecovery: true,
						Insights: &InsightsConfiguration{
							Enabled:               boolp(true),
							QueryStringLength:     4500,
							RecordApplicationTags: true,
							RecordClientAddress:   true,
						},
					},
				},
				Permissions: []CloudIAMPermission{
					{
						Role: "roles/cloudsql.client",
						Resource: CloudIAMResource{
							APIVersion: "resourcemanager.cnrm.cloud.google.com/v1beta1",
							Kind:       "Project",
							Name:       "myteam-dev-ab23",
						},
					},
				},
			},
			Influx: &Influx{
				Instance: "influx-instance",
			},
			Image: "navikt/testapp:69.0.0",
			Kafka: &Kafka{
				Pool:    "nav-dev",
				Streams: true,
			},
			Liveness: &Probe{
				FailureThreshold: 10,
				InitialDelay:     20,
				Path:             "/isalive",
				PeriodSeconds:    5,
				Port:             8080,
				Timeout:          1,
			},
			Logformat:    "accesslog_with_referer_useragent",
			Logtransform: "http_loglevel",
			Maskinporten: &Maskinporten{
				Enabled: true,
				Scopes: MaskinportenScope{
					ConsumedScopes: []ConsumedScope{
						{
							Name: "skatt:scope.read",
						},
					},
					ExposedScopes: []ExposedScope{
						{
							Enabled:             true,
							Name:                "scope.read",
							Product:             "arbeid",
							AllowedIntegrations: []string{"maskinporten"},
							AtMaxAge:            intp(30),
							Consumers: []ExposedScopeConsumer{
								{
									Orgno: "123456789",
									Name:  "KST",
								},
							},
							AccessibleForAll: boolp(true),
							DelegationSource: stringp("delegation-source"),
							Separator:        stringp(":"),
						},
					},
				},
			},
			OpenSearch: &OpenSearch{
				Instance: "my-open-search-instance",
				Access:   "readwrite",
			},
			Parallelism: int32p(1),
			PreStopHook: &PreStopHook{
				Exec: &ExecAction{
					Command: []string{"./my", "--shell", "script"},
				},
				Http: &HttpGetAction{
					Path: "/internal/stop",
					Port: intp(8080),
				},
			},
			Readiness: &Probe{
				FailureThreshold: 10,
				InitialDelay:     20,
				Path:             "/isready",
				PeriodSeconds:    5,
				Port:             8080,
				Timeout:          1,
			},
			Resources: &ResourceRequirements{
				Limits: &ResourceSpec{
					Cpu:    "500m",
					Memory: "512Mi",
				},
				Requests: &ResourceSpec{
					Cpu:    "200m",
					Memory: "256Mi",
				},
			},
			RestartPolicy: "Never",
			Schedule:      "*/15 0 0 0 0",
			SecureLogs: &SecureLogs{
				Enabled: true,
			},
			SkipCaBundle: true,
			Startup: &Probe{
				FailureThreshold: 10,
				InitialDelay:     20,
				Path:             "/started",
				PeriodSeconds:    5,
				Port:             8080,
				Timeout:          1,
			},
			SuccessfulJobsHistoryLimit:    2,
			TerminationGracePeriodSeconds: int64p(60),
			TimeZone:                      stringp("Europe/Oslo"),
			TTLSecondsAfterFinished:       int32p(60),
			Observability: &Observability{
				Tracing: &Tracing{
					Enabled: true,
				},
				Logging: &Logging{
					Enabled: true,
					Destinations: []LogDestination{
						{ID: "my-destination"},
					},
				},
				AutoInstrumentation: &AutoInstrumentation{
					Enabled: true,
					Runtime: "java",
				},
			},
			Vault: &Vault{
				Enabled: true,
				Sidecar: true,
				Paths: []SecretPath{
					{
						MountPath: "/var/run/secrets/nais.io/vault",
						KvPath:    "/kv/preprod/fss/application/namespace",
						Format:    "env",
					},
				},
			},
			WebProxy: true,
		},
	}
}