Skip to content

Latest commit

 

History

History

assisted-installer

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
hack
hack
 
 
network-templates
network-templates
 
 
steps
steps
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
add-nodes-bootstrap.sh
add-nodes-bootstrap.sh
 
 
authenticate-to-api.sh
authenticate-to-api.sh
 
 
bootstrap-create.sh
bootstrap-create.sh
 
 
bootstrap-install.sh
bootstrap-install.sh
 
 
bootstrap-post-install.sh
bootstrap-post-install.sh
 
 
bootstrap-scale-up.sh
bootstrap-scale-up.sh
 
 
bootstrap.sh
bootstrap.sh
 
 
configure-discovery-iso.sh
configure-discovery-iso.sh
 
 
create-cluster.sh
create-cluster.sh
 
 
destroy.sh
destroy.sh
 
 
download-iso.sh
download-iso.sh
 
 
example-mutli-network.cluster-vars.sh
example-mutli-network.cluster-vars.sh
 
 
example-mutli-network.demo-virt.cluster-vars.sh
example-mutli-network.demo-virt.cluster-vars.sh
 
 
example.cluster-vars.sh
example.cluster-vars.sh
 
 
nmstate-generator.sh
nmstate-generator.sh
 
 
patch-core-user-password.sh
patch-core-user-password.sh
 
 
patch-deployment.sh
patch-deployment.sh
 
 
preflight.sh
preflight.sh
 
 
query-openshift-versions.sh
query-openshift-versions.sh
 
 
start-new-host-installation.sh
start-new-host-installation.sh
 
 
validate-environment.sh
validate-environment.sh
 
 

README.md

Assisted Installer Scripts

Prerequisites

The following binaries need to be included in the system $PATH:

  • curl
  • jq
  • python3
  • j2cli
pip3 install j2cli

Chapter 4. Installing with the Assisted Installer API

https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform/2024/html/installing_openshift_container_platform_with_the_assisted_installer/installing-with-api#doc-wrapper

Assisted Installer Steps for Bare Metal machines with Static IPs

  1. Get offline token and save it to ~/rh-api-offline-token

Red Hat API Tokens

vim ~/rh-api-offline-token
  1. Get OpenShift Pull Secret and save it to ~/ocp-pull-secret

Install OpenShift on Bare Metal

vim ~/ocp-pull-secret
  1. Ensure there is an SSH Public Key at ~/.ssh/id_rsa.pub
ssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa
  1. Copy the cluster variables example file and modify as needed

Single NIC Deployments

cp example.cluster-vars.sh cluster-vars.sh
vim cluster-vars.sh

Multi Nic Deployments

cp example-mutli-network.cluster-vars.sh cluster-vars.sh
vim cluster-vars.sh

if using openshift-virtualization-gitops

ln -s custom-cluster-var.sh cluster-vars.sh

edit the custom-cluster-var.sh directly from git.

  1. Run the bootstrap script to create the cluster, configure it, and download the ISO

the bootstrap-create.sh script may also be used.

./bootstrap.sh

Sample expected output:

[kemo@raza assisted-installer]$ ./bootstrap.sh 

===== Running preflight...

===== Generating asset directory...
===== Checking for needed programs...
curl                                                                     PASSED!
jq                                                                       PASSED!
python3                                                                  PASSED!
===== Authenticating to the Red Hat API...
  Using Token: eyJhbGciOiJSUzI...

===== Querying the Assisted Installer Service for supported versions...
  Found Cluster Release 4.9.4 from target version 4.9

===== Preflight passed...

===== Cluster ai-poc.lab.local not found, creating now...

===== Creating a new cluster...
  CLUSTER_ID: dc3cfcc3-6a11-4fb2-a94f-e4fe8cac617f

===== Generating NMState Configuration files...
  Working with 3 nodes...
  Creating NMState config for ocp01...
  Creating NMState config for ocp02...
  Creating NMState config for ocp03...

===== Setting password authentication for core user...

===== Configuring Discovery ISO...
  Working with 3 nodes...
  Generating ISO Config for ocp01...
  Generating ISO Config for ocp02...
  Generating ISO Config for ocp03...

===== Patching Discovery ISO...

===== Waiting 15s for ISO to build...


===== Downloading Discovery ISO locally to ./.generated/ai-poc.lab.local/ai-liveiso-dc3cfcc3-6a11-4fb2-a94f-e4fe8cac617f.iso ...

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  987M  100  987M    0     0  58.5M      0  0:00:16  0:00:16 --:--:-- 61.6M

  1. Boot each machine with downloaded ISO

  2. Run the ./bootstrap-install.sh to start deployment to automate the tasks below.

Running bootstrap install manually

The bootstrap install script calls the scripts below in order. If you would like to walk thru the script call the scripts below.

  • source cluster-vars.sh && source authenticate-to-api.sh - sources variables to run scripts below.
  • steps/check-nodes-ready.sh - Checks to see if all the nodes have reported in
  • steps/set-node-hostnames-and-roles.sh - Set node hostnames and roles
  • steps/set-networking.sh - configures network and other settings TBH
  • steps/check-cluster-ready-to-install.sh - Check to see if the cluster is ready to install
  • steps/start-install.sh - Starts the Installation

Bootstrap Execution Overview

  • Run Preflight tasks - ensure files and variables are set, create asset generation directory
  • Authenticate to the Assisted Installer Service
  • Query the Assisted Installer Service for the supported OCP Release Version
  • Create a Cluster in the AI Svc if it does not already exist
  • Produce NMState configuration file
  • [Optional] Set core user password
  • Configure the Discovery ISO
  • Download the Discovery ISO

Generated assets can be found in ./.generated/${CLUSTER_NAME}.${CLUSTER_BASE_DNS}/

Add worker nodes to deployment

  • Modify your cluster-vars.sh file to add the worker nodes you want to add to the cluster.
  • Run the bootstrap-scale-up.sh script to generated the cluster expansion configuration
  • Boot the additional worker nodes with the downloaded Discovery ISO
  • Run the start-new-host-installation.sh script to start the installation of the new hosts
  • After node reboots run the ./hack/auto-approve-certs.sh script to approve the CSRs - or approve the nodes manually

Destroy Cluster

A simple script exists to delete a created cluster from the Assisted Installer Service and from the local file system:

## Requires a set cluster-vars.sh, looks for CLUSTER_ID in the `./.generated/${CLUSTER_NAME}.${CLUSTER_BASE_DNS}/` directory
./destroy.sh

Day 2 - Adding Additional Application Nodes

You can generate the Discovery ISO for a scaling action against a previously deployed cluster.

To do so, modify your cluster-vars.sh file to add the additional nodes, eg:

# ...
NODE6_CFG='{"name": "ocp06", "role": "application-node", "mac_address": "52:54:00:00:00:06", "ipv4": {"address": "192.168.42.66", "gateway": "192.168.42.1", "prefix": "24", "iface": "enp1s0"}}'
NODE7_CFG='{"name": "ocp07", "role": "application-node", "mac_address": "52:54:00:00:00:07", "ipv4": {"address": "192.168.42.67", "gateway": "192.168.42.1", "prefix": "24", "iface": "enp1s0"}}'

## Add Nodes to the JSON array
export NODE_CFGS='{ "nodes": [ '${NODE1_CFG}', '${NODE2_CFG}', '${NODE3_CFG}', '${NODE4_CFG}', '${NODE5_CFG}', '${NODE6_CFG}', '${NODE7_CFG}' ] }'
# ...
  • Run the bootstrap-scale-up.sh script to generated the cluster expansion configuration
  • Boot the additional worker nodes with the downloaded Discovery ISO
  • Run the start-new-host-installation.sh script to start the installation of the new hosts
  • After node reboots run the ./hack/auto-approve-certs.sh script to approve the CSRs - or approve the nodes manually

Note: You won't see the additional hosts cluster defined in the Web UI - additional node actions are performed via the API and oc CLI

Having already oc login'd to the original cluster, wait for the host to report in as a node's CertificateSigningRequest and approve it:

See ./hack/auto-approve-certs.sh

oc get csr|grep Pending

# Approve all CSR
for csr in $(oc -n openshift-machine-api get csr | awk '/Pending/ {print $1}'); do oc adm certificate approve $csr;done

VMWARE Govc commands

You may use this to quickly upload iso to vSphere

Install Govc

$ curl -L https://github.com/vmware/govmomi/releases/download/v0.28.0/govc_Linux_x86_64.tar.gz  | tar -C /usr/local/bin -xvzf - govc
$ chmod +x /usr/local/bin/govc
$ govc

Import OVA template

Download trusted root CA certificates from the vSphere Web Services SDK

export vcenter_fqdn=my_vcenter_fqdn
curl -OL -k https://$vcenter_fqdn/certs/download.zip

unzip the certs

unzip download.zip

Copy the certs into the anchors directory

cp certs/lin/* /etc/pki/ca-trust/source/anchors

Update the ca-trust

update-ca-trust extract

Push ISO to vSphere

# Create iso folder in vSphere Datastore 
$ export GOVC_URL=https://${vcenter_fqdn}/sdk
$ export [email protected]
$ export GOVC_PASSWORD="vsphere-password"
$ govc datastore.upload -ds Datastore1 ./.generated/ocp4.example.com/ai-liveiso-7cf94369-8b3d-4e73-afa1-aac911a00948.iso ISOs/ai-liveiso-7cf94369-8b3d-4e73-afa1-aac911a00948.iso

Links

Branch Testing for Developers

Review Hack-y scripts before start testing

## Clone & Checkout
git clone https://github.com/tosin2013/openshift-4-deployment-notes.git
cd openshift-4-deployment-notes

cd assisted-installer/

## Copy/edit vars
cp example.cluster-vars.sh cluster-vars.sh
vim cluster-vars.sh

## Start a full libvirt install
## - Create the OpenShift Cluster in the AI Service
## - [Optional Hack] Create VMs locally with Libvirt
## - Configure and Start the OpenSHift Install via the AI Service
## - [Optional Hack] Watch virsh and restart VMs when needed
## - Post-Install Cluster Configuration & Output

./bootstrap.sh \
 && ./hack/create-kvm-vms.sh \
 && ./bootstrap-install.sh \
 && ./hack/watch-and-reboot-kvm-vms.sh #test for node addition \
 && ./bootstrap-post-install.sh


 ## to add aditional test vm 
./add-nodes-bootstrap.sh
./hack/create-kvm-vms.sh 

 ## To destory test vms
 ./hack/delete-kvm-vms.sh 
 ./destroy.sh