Docs: minor fixes (#608)
* Link to project's DockerHub in README's section on nightly builds, add paragraph about nightly builds in installation docs * Fix repositoryURL in sample seedJob configuration with SSH auth * Slightly expand on #348 * Fix formatting in docs on Jenkins' customization, update plugin versions * Add notes on Jenkins home Volume in Helm chart values.yaml and docs (#589)
This commit is contained in:
Szymon Fugas
GitHub
parent
935b60b6d8
commit
dfd25e822c
|
|
@ -64,12 +64,15 @@ Selected content:
|
|||
## Community
|
||||
|
||||
We have a dedicated channel called `#jenkins-operator` on [virtuslab-oss.slack.com](https://virtuslab-oss.slack.com)
|
||||
Fill out ([Invite form](https://forms.gle/X3X8qA1XMirdBuEH7)) and come say hi !
|
||||
Fill out ([Invite form](https://forms.gle/X3X8qA1XMirdBuEH7)) and come say hi!
|
||||
|
||||
## Snapshots between releases
|
||||
|
||||
We are trying our best to resolve issues quickly, but they have to wait to be released. If you can't wait for an official
|
||||
docker image release and acknowledge the risk, you can use our unofficial images, which are built nightly.
|
||||
|
||||
You can find the project's Docker Hub repository [here](https://hub.docker.com/r/virtuslab/jenkins-operator).
|
||||
|
||||
Look for the images with tag "{git-hash}", where {git-hash} is the hash of the master commit that interests you.
|
||||
|
||||
## Contribution
|
||||
|
|
|
|||
|
|
@ -120,6 +120,8 @@ jenkins:
|
|||
claimName: jenkins-backup
|
||||
|
||||
# volumeMounts are mounts for Jenkins pod
|
||||
# Note that attempting to overwrite default mount settings for Jenkins home directory will result in Operator error
|
||||
# See https://jenkinsci.github.io/kubernetes-operator/docs/installation/#note-on-jenkins-home-volume
|
||||
volumeMounts: []
|
||||
|
||||
# defines authorization strategy of the operator for the Jenkins API
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: "Developer Guide"
|
||||
linkTitle: "Developer Guide"
|
||||
weight: 60
|
||||
date: 2021-06-10
|
||||
date: 2021-07-30
|
||||
description: >
|
||||
Jenkins Operator for developers
|
||||
---
|
||||
|
|
@ -211,6 +211,16 @@ seed-job-agent-jenkins-example-758cc7cc5c-82hbl 1/1 Running 0
|
|||
make run OPERATOR_EXTRA_ARGS="--debug"
|
||||
```
|
||||
|
||||
### Stop or delete minikube cluster
|
||||
To stop Kubernetes cluster running locally on minikube:
|
||||
```bash
|
||||
minikube stop
|
||||
```
|
||||
To delete the cluster altogether:
|
||||
```bash
|
||||
minikube delete
|
||||
```
|
||||
|
||||
## Build and run with a remote Kubernetes cluster
|
||||
|
||||
You can also run the controller locally and make it listen to a remote Kubernetes server.
|
||||
|
|
@ -282,6 +292,18 @@ kubectl get secret jenkins-operator-credentials-<cr_name> -o 'jsonpath={.data.us
|
|||
kubectl get secret jenkins-operator-credentials-<cr_name> -o 'jsonpath={.data.password}' | base64 -d
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## Self-learning
|
||||
|
||||
* [Tutorial: Deep Dive into the Operator Framework for... Melvin Hillsman, Michael Hrivnak, & Matt Dorn
|
||||
](https://www.youtube.com/watch?v=8_DaCcRMp5I)
|
||||
|
||||
* [Operator Framework Training By OpenShift](https://www.katacoda.com/openshift/courses/operatorframework)
|
||||
|
||||
* [Operator SDK Tutorial for Go](https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/)
|
||||
|
||||
[dep_tool]:https://golang.github.io/dep/docs/installation.html
|
||||
[git_tool]:https://git-scm.com/downloads
|
||||
[go_tool]:https://golang.org/dl/
|
||||
|
|
@ -293,9 +315,3 @@ kubectl get secret jenkins-operator-credentials-<cr_name> -o 'jsonpath={.data.pa
|
|||
[virtualbox]:https://www.virtualbox.org/wiki/Downloads
|
||||
[install_dev_tools]:https://jenkinsci.github.io/kubernetes-operator/docs/developer-guide/tools/
|
||||
|
||||
## Self-learning
|
||||
|
||||
* [Tutorial: Deep Dive into the Operator Framework for... Melvin Hillsman, Michael Hrivnak, & Matt Dorn
|
||||
](https://www.youtube.com/watch?v=8_DaCcRMp5I)
|
||||
|
||||
* [Operator Framework Training By OpenShift](https://www.katacoda.com/openshift/courses/operatorframework)
|
||||
|
|
|
|||
|
|
@ -163,7 +163,7 @@ spec:
|
|||
targets: "cicd/jobs/*.jenkins"
|
||||
description: "Jenkins Operator repository"
|
||||
repositoryBranch: master
|
||||
repositoryUrl: ssh://git@github.com:jenkinsci/kubernetes-operator.git
|
||||
repositoryUrl: git@github.com:jenkinsci/kubernetes-operator.git
|
||||
```
|
||||
|
||||
and create a Kubernetes Secret (name of secret should be the same from `credentialID` field):
|
||||
|
|
|
|||
|
|
@ -13,13 +13,14 @@ Plugin's configuration is applied as groovy scripts or the [configuration as cod
|
|||
Any plugin working for Jenkins can be installed by the Jenkins Operator.
|
||||
|
||||
Pre-installed plugins:
|
||||
* configuration-as-code v1.47
|
||||
* git v4.5.0
|
||||
|
||||
* configuration-as-code v1.51
|
||||
* git v4.7.2
|
||||
* job-dsl v1.77
|
||||
* kubernetes-credentials-provider v0.15
|
||||
* kubernetes v1.29.0
|
||||
* kubernetes-credentials-provider v0.18-1
|
||||
* kubernetes v1.30.0
|
||||
* workflow-aggregator v2.6
|
||||
* workflow-job v2.40
|
||||
* workflow-job v2.41
|
||||
|
||||
Rest of the plugins can be found in [plugins repository](https://plugins.jenkins.io/).
|
||||
|
||||
|
|
@ -51,19 +52,19 @@ spec:
|
|||
master:
|
||||
basePlugins:
|
||||
- name: kubernetes
|
||||
version: "1.28.6"
|
||||
version: "1.30.0"
|
||||
- name: workflow-job
|
||||
version: "2.40"
|
||||
- name: workflow-aggregator
|
||||
version: "2.6"
|
||||
- name: git
|
||||
version: "4.5.0"
|
||||
version: "4.7.2"
|
||||
- name: job-dsl
|
||||
version: "1.77"
|
||||
- name: configuration-as-code
|
||||
version: "1.46"
|
||||
version: "1.51"
|
||||
- name: kubernetes-credentials-provider
|
||||
version: "0.15"
|
||||
version: "0.18-1"
|
||||
```
|
||||
|
||||
You can change their versions.
|
||||
|
|
|
|||
|
|
@ -2,24 +2,25 @@
|
|||
title: "Installation"
|
||||
linkTitle: "Installation"
|
||||
weight: 1
|
||||
date: 2020-10-05
|
||||
date: 2021-07-30
|
||||
description: >
|
||||
How to install Jenkins Operator
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This document describes installation procedure for **Jenkins Operator**.
|
||||
All container images can be found at [virtuslab/jenkins-operator](https://hub.docker.com/r/virtuslab/jenkins-operator)
|
||||
All container images can be found at [virtuslab/jenkins-operator](https://hub.docker.com/r/virtuslab/jenkins-operator) Docker Hub repository.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
## Requirements
|
||||
|
||||
To run **Jenkins Operator**, you will need:
|
||||
|
||||
- access to a Kubernetes cluster version `1.17+`
|
||||
- `kubectl` version `1.17+`
|
||||
|
||||
|
||||
Listed below are the two ways to deploy Jenkins Operator. For details on how to customize your Jenkins instance, refer to [Getting Started](/kubernetes-operator/docs/installation/)
|
||||
Listed below are the two ways to deploy Jenkins Operator. For details on how to customize your Jenkins instance, refer to [Getting Started](/kubernetes-operator/docs/installation/).
|
||||
|
||||
## Deploy Jenkins Operator using YAML's
|
||||
|
||||
|
|
@ -877,3 +878,12 @@ Example:<br />
|
|||
</tbody>
|
||||
</table>
|
||||
|
||||
## Note on Operator's nightly built images
|
||||
If you wish to use the newest, not yet released version of the Operator, you can use one of nightly built snapshot images, however the maintainers of this project cannot guarantee their stability.
|
||||
|
||||
You can find nightly built images by heading to [virtuslab/jenkins-operator](https://hub.docker.com/r/virtuslab/jenkins-operator) Docker Hub repository and looking for images with tag in the form of "{git-hash}", {git-hash} being the hash of master branch commit that you want to use snapshot of.
|
||||
|
||||
## Note on Jenkins home Volume
|
||||
Current design of the Operator puts an emphasis on creating a full GitOps flow of work for Jenkins users. One of the key points of this design is maintaining an immutable state of Jenkins.
|
||||
|
||||
One of the prerequisites of this is an ephemeral Jenkins home directory. To achieve that, Operator mounts emptyDir Volume as Jenkins home directory. It is not possible to overwrite volumeMount and specify any other Volume for Jenkins home directory, as attempting to do so will result in Operator error.
|
||||
Loading…
Reference in New Issue