From aeaad41ab4459fd1c78c22f7099e0e6125d925c8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Lino?= Date: Wed, 15 Apr 2020 10:48:04 +0100 Subject: [PATCH] Some basic documentation with basic instructions. --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 8b230e3..1fab143 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ +# Jenkins for CI/CD demonstration purposes + +`DISCLAMER` This project started off as a fork from https://github.com/helm/charts/tree/master/stable/jenkins where the default Jenkins Helm Char lives. After the how to section, this readme is more or less a copy of the forked readme. `DISCLAMER` + +Here you can find a collection of scripts, configurations and helm chart to deploy Jenkins as part of my CI/CD demonstration. + +`demo-infra-jenkins-install.sh` is used to preform the initial installation. Should be run to install Jenkins properly in Kubernetes. + +`demo-infra-jenkins-uninstall.sh` is used to stand up uninstall Jenkins. Should be run to remove Jenkins properly from Kubernetes. + +## How to use +1. Clone this repo into the machine and change directory into it. + +2. run `demo-infra-jenkins-install.sh` to install/configure/start/expose Jenkins in Kubernetes. +```bash +$ sh demo-infra-jenkins-install.sh +``` +As an output of this script you'll get the admin user credentials required to access Jenkins. + +### How to remove + +1. Clone this repo into the machine and change directory into it. + +2. run `demo-infra-jenkins-uninstall.sh` to uninstall Jenkins from Kubernetes. +```bash +$ sh demo-infra-jenkins-uninstall.sh +``` + # Jenkins Helm Chart Jenkins master and agent cluster utilizing the Jenkins Kubernetes plugin -- 2.24.1