Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate handbook install chapter into sections #3874

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions content/doc/book/installing/_chapter.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
---
sections:
- docker
- kubernetes
- linux
- macos
- war-file
- windows
- other
- offline
- initial-settings
10 changes: 5 additions & 5 deletions content/doc/book/installing/_docker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ _run-jenkins-in-docker.adoc).
////


===== On macOS and Linux
=== On macOS and Linux

. Open up a terminal window.
. Create a link:https://docs.docker.com/network/bridge/[bridge network] in
Expand Down Expand Up @@ -196,7 +196,7 @@ docker container run --name jenkins-blueocean --rm --detach \
. Proceed to the <<setup-wizard,Post-installation setup wizard>>.


===== On Windows
=== On Windows

The Jenkins project provides a Linux container image, not a Windows container image.
Be sure that your Docker for Windows installation is configured to run `Linux Containers` rather than `Windows Containers`.
Expand Down Expand Up @@ -257,7 +257,7 @@ macOS and Linux>> instructions above.
. Proceed to the <<setup-wizard,Post-installation setup wizard>>.

[[accessing-the-jenkins-blue-ocean-docker-container]]
==== Accessing the Jenkins/Blue Ocean Docker container
== Accessing the Jenkins/Blue Ocean Docker container

If you have some experience with Docker and you wish or need to access the
`jenkinsci/blueocean` container through a terminal/command prompt using the
Expand All @@ -273,7 +273,7 @@ prompt window) with a `docker container exec` command like:
`docker container exec -it jenkins-blueocean bash`


==== Accessing the Jenkins console log through Docker logs
== Accessing the Jenkins console log through Docker logs

There is a possibility you may need to access the Jenkins console log, for
instance, when <<unlocking-jenkins,Unlocking Jenkins>> as part of the
Expand Down Expand Up @@ -302,7 +302,7 @@ Ocean Docker container>>), you can simply use the `docker container logs` comman
`docker container logs jenkins-blueocean`


==== Accessing the Jenkins home directory
== Accessing the Jenkins home directory

There is a possibility you may need to access the Jenkins home directory, for
instance, to check the details of a Jenkins build in the `workspace`
Expand Down
30 changes: 30 additions & 0 deletions content/doc/book/installing/_installation_requirements.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
////
This file is only meant to be included as a snippet in other documents.
There is a version of this file for the general 'Installing Jenkins' page
(index.adoc) and another for tutorials (_run-jenkins-in-docker.adoc).
This file is for the index.adoc page used in the general 'Installing Jenkins'
page.
////

== Prerequisites

Minimum hardware requirements:

* 256 MB of RAM
* 1 GB of drive space (although 10 GB is a recommended minimum if running
Jenkins as a Docker container)

Recommended hardware configuration for a small team:

* 1 GB+ of RAM
* 50 GB+ of drive space

Comprehensive hardware recommendations:

* Hardware: see the link:/doc/book/scaling/hardware-recommendations[Hardware Recommendations] page

Software requirements:

* Java: see the link:/doc/administration/requirements/java[Java Requirements] page
* Web browser: see the link:/doc/administration/requirements/web-browsers[Web Browser Compatibility] page
* For Windows operating system: link:/doc/administration/requirements/windows[Windows Support Policy]
2 changes: 1 addition & 1 deletion content/doc/book/installing/_run-jenkins-in-docker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To run Jenkins in Docker, follow the relevant instructions below for either
<<on-macos-and-linux,macOS and Linux>> or <<on-windows,Windows>>.

You can read more about Docker container and image concepts in the
link:../../book/installing#docker[Docker]
link:../../book/installing/docker[Docker]
section of the link:../../book/installing[Installing Jenkins] page.

include::_docker-for-tutorials.adoc[]
Expand Down
3 changes: 0 additions & 3 deletions content/doc/book/installing/_setup-wizard.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,3 @@ plugins>>, Jenkins asks you to create your first administrator user.
browser to refresh the page manually.
. If required, log in to Jenkins with the credentials of the user you just
created and you are ready to start using Jenkins!

IMPORTANT: From this point on, the Jenkins UI is only accessible by providing
valid username and password credentials.
96 changes: 96 additions & 0 deletions content/doc/book/installing/docker.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
layout: section
title: Docker
---
ifdef::backend-html5[]
:description:
:author:
:email: jenkinsci-docs@googlegroups.com
:sectanchors:
:toc:
:toclevels: 4
:hide-uri-scheme:
ifdef::env-github[:imagesdir: ../resources]
ifndef::env-github[:imagesdir: ../../resources]
endif::[]

= Docker

////
IMPORTANT: If you update content in this section, please ensure you check these
changes against the procedures documented in the
'tutorials/_prerequisites.adoc' file, which is used in the Guided Tour of the
Jenkins Documentation.
////

link:https://docs.docker.com/engine/docker-overview/[Docker] is a platform for
running applications in an isolated environment called a "container" (or Docker
container). Applications like Jenkins can be downloaded as read-only "images"
(or Docker images), each of which is run in Docker as a container. A Docker
container is in effect a "running instance" of a Docker image. From this
perspective, an image is stored permanently more or less (i.e. insofar as image
updates are published), whereas containers are stored temporarily. Read more
about these concepts in the Docker documentation's
link:https://docs.docker.com/get-started/[Getting Started, Part 1: Orientation
and setup] page.

Docker's fundamental platform and container design means that a single Docker
image (for any given application like Jenkins) can be run on any supported
operating system (macOS, Linux and Windows) or cloud service (AWS and Azure)
which is also running Docker.

== Installing Docker

To install Docker on your operating system, follow "prerequisits" section of the
link:/doc/pipeline/tour/getting-started/#prerequisites[Guided Tour page]

As an alternative solution you can visit the
link:https://store.docker.com/search?type=edition&offering=community[Docker
store] website and click the *Docker Community Edition* box which is suitable
for your operating system or cloud service. Follow the installation instructions
on their website.

Jenkins can also run on Docker Enterprise Edition, which you can access through
*Docker EE* on the Docker store website.

[CAUTION]
====
If you are installing Docker on a Linux-based operating system, ensure
you configure Docker so it can be managed as a non-root user. Read more about
this in Docker's
link:https://docs.docker.com/engine/installation/linux/linux-postinstall/[Post-installation
steps for Linux] page of their documentation. This page also contains
information about how to configure Docker to start on boot.
====

include::doc/book/installing/_installation_requirements.adoc[]

== Downloading and running Jenkins in Docker

There are several Docker images of Jenkins available.

The recommended Docker image to use is the
link:https://hub.docker.com/r/jenkinsci/blueocean/[`jenkinsci/blueocean` image]
(from the link:https://hub.docker.com/[Docker Hub repository]). This image
contains the current link:/download[Long-Term Support (LTS) release of Jenkins]
(which is production-ready) bundled with all Blue Ocean plugins and features.
This means that you do not need to install the Blue Ocean plugins separately.

[NOTE]
====
A new `jenkinsci/blueocean` image is published each time a new release of Blue
Ocean is published. You can see a list of previously published versions of the
`jenkinsci/blueocean` image on the
link:https://hub.docker.com/r/jenkinsci/blueocean/tags/[tags] page.

There are also other Jenkins Docker images you can use (accessible through
link:https://hub.docker.com/r/jenkins/jenkins/[`jenkins/jenkins`] on Docker
Hub). However, these do not come with Blue Ocean, which would need to be
installed via the link:../managing[*Manage Jenkins*] >
link:../managing/plugins[*Manage Plugins*] page in Jenkins. Read more
about this in link:../blueocean/getting-started[Getting started with Blue Ocean].
====

include::doc/book/installing/_docker.adoc[]

include::doc/book/installing/_setup-wizard.adoc[]
Loading