diff --git a/README.md b/README.md index 2ebd2ef3..141fb51b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Jenkins Operator -[![Version](https://img.shields.io/badge/version-v0.1.1-brightgreen.svg)](https://github.com/jenkinsci/kubernetes-operator/releases/tag/v0.1.1) +[![Version](https://img.shields.io/badge/version-v0.2.0-brightgreen.svg)](https://github.com/jenkinsci/kubernetes-operator/releases/tag/v0.2.0) [![Build Status](https://travis-ci.org/jenkinsci/kubernetes-operator.svg?branch=master)](https://travis-ci.org/jenkinsci/kubernetes-operator) [![Go Report Card](https://goreportcard.com/badge/github.com/jenkinsci/kubernetes-operator "Go Report Card")](https://goreportcard.com/report/github.com/jenkinsci/kubernetes-operator) [![Docker Pulls](https://img.shields.io/docker/pulls/virtuslab/jenkins-operator.svg)](https://hub.docker.com/r/virtuslab/jenkins-operator/tags) @@ -52,8 +52,8 @@ Feel free to file [issues](https://github.com/jenkinsci/kubernetes-operator/issu This project was originally developed by [VirtusLab](https://virtuslab.com/) and the following [CONTRIBUTORS](https://github.com/jenkinsci/kubernetes-operator/graphs/contributors). [installation]:documentation/installation.md -[getting_started]:documentation/v0.1.1/getting-started.md +[getting_started]:documentation/v0.2.0/getting-started.md [how_it_works]:documentation/how-it-works.md [security]:documentation/security.md [developer_guide]:documentation/developer-guide.md -[jenkins_scheme]:documentation/v0.1.1/jenkins-v1alpha2-scheme.md \ No newline at end of file +[jenkins_scheme]:documentation/v0.2.0/jenkins-v1alpha2-scheme.md \ No newline at end of file diff --git a/VERSION.txt b/VERSION.txt index 8308b63a..1474d00f 100644 --- a/VERSION.txt +++ b/VERSION.txt @@ -1 +1 @@ -v0.1.1 +v0.2.0 diff --git a/deploy/all-in-one-v1alpha2.yaml b/deploy/all-in-one-v1alpha2.yaml index 9fda8470..92e236ec 100644 --- a/deploy/all-in-one-v1alpha2.yaml +++ b/deploy/all-in-one-v1alpha2.yaml @@ -126,7 +126,7 @@ spec: serviceAccountName: jenkins-operator containers: - name: jenkins-operator - image: virtuslab/jenkins-operator:v0.1.1 + image: virtuslab/jenkins-operator:v0.2.0 command: - jenkins-operator args: [] diff --git a/deploy/operator.yaml b/deploy/operator.yaml index 64890cee..16c7ff45 100644 --- a/deploy/operator.yaml +++ b/deploy/operator.yaml @@ -16,7 +16,7 @@ spec: serviceAccountName: jenkins-operator containers: - name: jenkins-operator - image: virtuslab/jenkins-operator:v0.1.1 + image: virtuslab/jenkins-operator:v0.2.0 command: - jenkins-operator args: [] diff --git a/documentation/v0.2.0/jenkins-v1alpha2-scheme.md b/documentation/v0.2.0/jenkins-v1alpha2-scheme.md index de25e2ae..0707132f 100644 --- a/documentation/v0.2.0/jenkins-v1alpha2-scheme.md +++ b/documentation/v0.2.0/jenkins-v1alpha2-scheme.md @@ -163,6 +163,34 @@ Restore More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore

+ + +groovyScripts
+ + +GroovyScripts + + + + +(Optional) +

GroovyScripts defines configuration of Jenkins customization via groovy scripts

+ + + + +configurationAsCode
+ + +ConfigurationAsCode + + + + +(Optional) +

ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin

+ + @@ -181,6 +209,69 @@ JenkinsStatus +

AppliedGroovyScript +

+

+(Appears on: +JenkinsStatus) +

+

+

AppliedGroovyScript is the applied groovy script in Jenkins by the operator

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+configurationType
+ +string + +		 +

ConfigurationType is the name of the configuration type(base-groovy, user-groovy, user-casc)

+
+source
+ +string + +		 +

Source is the name of source where is located groovy script

+
+name
+ +string + +		 +

Name is the name of the groovy script

+
+Hash
+ +string + +		 +

Hash is the hash of the groovy script and secrets which it uses

+

Backup

@@ -247,14 +338,14 @@ bool -

Build +

ConfigMapRef

(Appears on: -JenkinsStatus) +Customization)

-

Build defines Jenkins Build status with corresponding metadata

+

ConfigMapRef is reference to Kubernetes ConfigMap

@@ -266,98 +357,47 @@ bool - - - - - - - - - - - - - - - - - - - - - - - -
-jobName
+name
string 		-

JobName is the Jenkins job name

-
-hash
- -string - -		 -

Hash is the unique data identifier used in build

-
-number
- -int64 - -		 -

Number is the Jenkins build number

-
-status
- - -BuildStatus - - -		 -

Status is the status of Jenkins build

-
-retries
- -int - -		 -

Retires is the amount of Jenkins job build retries

-
-createTime
- - -Kubernetes meta/v1.Time - - -		 -

CreateTime is the time when the first build has been created

-
-lastUpdateTime
- - -Kubernetes meta/v1.Time - - -		 -

LastUpdateTime is the last update status time
-

BuildStatus -(string alias)

+

ConfigurationAsCode +

(Appears on: -Build) +JenkinsSpec)

-

BuildStatus defines type of Jenkins build job status

+

ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin

+ + + + + + + + + + + + + +
FieldDescription
+Customization
+ + +Customization + + +		 +

Container

@@ -605,6 +645,81 @@ More info: Customization + +

+(Appears on: +ConfigurationAsCode, +GroovyScripts) +

+

+

Customization defines configuration of Jenkins customization

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+secret
+ + +SecretRef + + +		 +
+configurations
+ + +[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.ConfigMapRef + + +		 +
+

GroovyScripts +

+

+(Appears on: +JenkinsSpec) +

+

+

GroovyScripts defines configuration of Jenkins customization via groovy scripts

+

+ + + + + + + + + + + + + +
FieldDescription
+Customization
+ + +Customization + + +		 +

Handler

@@ -761,6 +876,23 @@ memory: 600Mi

+imagePullSecrets
+ + +[]Kubernetes core/v1.LocalObjectReference + + + + +(Optional) +

ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. +If specified, these secrets will be passed to individual puller implementations for them to use. For example, +in the case of docker, only DockerConfig type secrets are honored. +More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod

+ + + + volumes
@@ -930,6 +1062,34 @@ Restore More info: https://github.com/jenkinsci/kubernetes-operator/blob/master/docs/getting-started.md#configure-backup-and-restore

+ + +groovyScripts
+ + +GroovyScripts + + + + +(Optional) +

GroovyScripts defines configuration of Jenkins customization via groovy scripts

+ + + + +configurationAsCode
+ + +ConfigurationAsCode + + + + +(Optional) +

ConfigurationAsCode defines configuration of Jenkins customization via Configuration as Code Jenkins plugin

+ +

JenkinsStatus @@ -1005,20 +1165,6 @@ Kubernetes meta/v1.Time -builds
- - -[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Build - - - - -(Optional) -

Builds contains Jenkins builds statues

- - - - restoredBackup
uint64 @@ -1089,8 +1235,207 @@ string

CreatedSeedJobs contains list of seed job id already created in Jenkins

+ + +appliedGroovyScripts
+ + +[][]github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.AppliedGroovyScript + + + + +(Optional) +

AppliedGroovyScripts is a list with all applied groovy scripts in Jenkins by the operator

+ + +

Mailgun +

+

+(Appears on: +Notification) +

+

+

Mailgun is handler for Mailgun email service notification channel

+

+ + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+domain
+ +string + +		 +
+apiKeySecretKeySelector
+ + +SecretKeySelector + + +		 +
+recipient
+ +string + +		 +
+from
+ +string + +		 +
+

MicrosoftTeams +

+

+(Appears on: +Notification) +

+

+

MicrosoftTeams is handler for Microsoft MicrosoftTeams notification channel

+

+ + + + + + + + + + + + + +
FieldDescription
+webHookURLSecretKeySelector
+ + +SecretKeySelector + + +		 +

The web hook URL to MicrosoftTeams App

+
+

Notification +

+

+

Notification is a service configuration used to send notifications about Jenkins status

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FieldDescription
+loggingLevel
+ + +NotificationLogLevel + + +		 +
+verbose
+ +bool + +		 +
+name
+ +string + +		 +
+slack
+ + +github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Slack + + +		 +
+teams
+ + +github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.MicrosoftTeams + + +		 +
+mailgun
+ + +github.com/jenkinsci/kubernetes-operator/pkg/apis/jenkins/v1alpha2.Mailgun + + +		 +
+

NotificationLogLevel +(string alias)

+

+(Appears on: +Notification) +

+

+

NotificationLogLevel defines logging level of Notification

+

Plugin

@@ -1187,6 +1532,80 @@ uint64 +

SecretKeySelector +

+

+(Appears on: +Mailgun, +MicrosoftTeams, +Slack) +

+

+

SecretKeySelector selects a key of a Secret.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+secret
+ + +Kubernetes core/v1.LocalObjectReference + + +		 +

The name of the secret in the pod’s namespace to select from.

+
+key
+ +string + +		 +

The key of the secret to select from. Must be a valid secret key.

+
+

SecretRef +

+

+(Appears on: +Customization) +

+

+

SecretRef is reference to Kubernetes secret

+

+ + + + + + + + + + + + + +
FieldDescription
+name
+ +string + +		 +

SeedJob

@@ -1286,6 +1705,90 @@ JenkinsCredentialType

JenkinsCredentialType is the https://jenkinsci.github.io/kubernetes-credentials-provider-plugin/ credential type

+ + +githubPushTrigger
+ +bool + + + +(Optional) +

GitHubPushTrigger is used for GitHub web hooks

+ + + + +buildPeriodically
+ +string + + + +(Optional) +

BuildPeriodically is setting for scheduled trigger

+ + + + +pollSCM
+ +string + + + +(Optional) +

PollSCM is setting for polling changes in SCM

+ + + + +ignoreMissingFiles
+ +bool + + + +(Optional) +

IgnoreMissingFiles is setting for Job DSL API plugin to ignore files that miss

+ + + + +additionalClasspath
+ +string + + + +(Optional) +

AdditionalClasspath is setting for Job DSL API plugin to set Additional Classpath

+ + + + +failOnMissingPlugin
+ +bool + + + +(Optional) +

FailOnMissingPlugin is setting for Job DSL API plugin that fails job if required plugin is missing

+ + + + +unstableOnDeprecation
+ +bool + + + +(Optional) +

UnstableOnDeprecation is setting for Job DSL API plugin that sets build status as unstable if build using deprecated features

+ +

Service @@ -1424,8 +1927,40 @@ This field will be ignored if the cloud-provider does not support the feature. +

Slack +

+

+(Appears on: +Notification) +

+

+

Slack is handler for Slack notification channel

+

+ + + + + + + + + + + + + +
FieldDescription
+webHookURLSecretKeySelector
+ + +SecretKeySelector + + +		 +

The web hook URL to Slack App

+

Generated with gen-crd-api-reference-docs -on git commit 37e531a. +on git commit f4c4235.