From 79e1d2c3e5aa81427a0f291d22f0121c777e1cda Mon Sep 17 00:00:00 2001 From: Luigi Molinaro Date: Wed, 20 Mar 2024 16:02:18 +0000 Subject: [PATCH] Add Option to Downloading the Cloud Pak Deployer Image from quay.io --- docs/src/05-install/install.md | 44 +++++++++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 6 deletions(-) diff --git a/docs/src/05-install/install.md b/docs/src/05-install/install.md index e8e7255b0..31328e08c 100644 --- a/docs/src/05-install/install.md +++ b/docs/src/05-install/install.md @@ -1,17 +1,20 @@ # Installing the Cloud Pak Deployer -## Install pre-requisites -The Cloud Pak Deployer requires `podman` or `docker` to run, which are available on most Linux distributions such as Red Hat Enterprise Linux (preferred), Fedora, CentOS, Ubuntu and MacOS. On Windows Docker behaves differently than Linux platforms and this can cause the deployer to fail. +## Prerequisites + +To install and run the Cloud Pak Deployer, ensure that either podman or docker is available on your system. These are typically available on various Linux distributions such as Red Hat Enterprise Linux (preferred), Fedora, CentOS, Ubuntu, and MacOS. Note that Docker behaves differently on Windows compared to Linux platforms, potentially causing deployment issues. ### Using a Windows workstation -If you don't have a Linux server in some cloud, you can use VirtualBox to create a Linux virtual machine. + +If you're working on a Windows workstation without access to a Linux server, you can use VirtualBox to create a Linux virtual machine for deployment. * Install VirtualBox: https://www.virtualbox.org * Install a Linux guest operating system: https://www.virtualbox.org/wiki/Guest_OSes -Once the guest operating system is up and running, log on as root to the guest operating system. For convenience, VirtualBox also supports port forwarding so you can use `PuTTY` to access the Linux command line. +Once the guest operating system is set up, log in as root. VirtualBox supports port forwarding for easy access to the Linux command line using tools like PuTTY. ### Install on Linux + On Red Hat Enterprise Linux of CentOS, run the following commands: ``` yum install -y podman git @@ -25,11 +28,19 @@ podman machine create podman machine init ``` -On Ubuntu, follow the instructions here: https://docs.docker.com/engine/install/ubuntu/ +On Ubuntu, debian Based : +``` +apt-get -y install podman +podman machine create +podman machine init +``` + +Generally, adhere to the instructions provided to install either podman or docker on your Linux system. ## Clone the current repository ### Using the command line + If you clone the repository from the command line, you will need to enter a token when you run the `git clone` command. You can retrieve your token as follows: Go to a directory where you want to download the Git repo. @@ -38,6 +49,7 @@ git clone --depth=1 https://github.com/IBM/cloud-pak-deployer.git ``` ## Build the image + First go to the directory where you cloned the GitHub repository, for example `~/cloud-pak-deployer`. ``` cd cloud-pak-deployer @@ -48,4 +60,24 @@ Then run the following command to build the container image. ./cp-deploy.sh build ``` -This process will take 5-10 minutes to complete and it will install all the pre-requisites needed to run the automation, including Ansible, Python and required operating system packages. For the installation to work, the system on which the image is built must be connected to the internet. \ No newline at end of file +This process will take 5-10 minutes to complete and it will install all the pre-requisites needed to run the automation, including Ansible, Python and required operating system packages. For the installation to work, the system on which the image is built must be connected to the internet. + +### Downloading the Cloud Pak Deployer Image + +To download the Cloud Pak Deployer image from the Quay.io registry, you can use the Docker command-line interface (CLI) or Podman. + +```bash +podman pull quay.io/cloud-pak-deployer/cloud-pak-deployer +``` + +This command pulls the latest version of the Cloud Pak Deployer image from the Quay.io repository. Once downloaded, you can use this image to deploy Cloud Paks + +### Tags and Versions + +By default, the above command pulls the latest version of the Cloud Pak Deployer image. If you want to specify a particular version or tag, you can append it to the image name. For example: + +```bash +podman pull quay.io/cloud-pak-deployer/cloud-pak-deployer: +``` + +Replace `` with the specific tag or version you want to download. \ No newline at end of file