Merge pull request devfile#101 from kim-tsao/update-scripts

Update scripts to work with podman

Author: kim-tsao

README.md

@@ -6,6 +6,9 @@ Issue tracking repo: https://github.com/devfile/api with label area/registry
 
 ## Build
 
+If you want to run the build scripts with Podman, set the environment variable
+`export USE_PODMAN=true`
+
 To build all of the components together (recommended) for dev/test, run `./build_registry.sh` to build a Devfile Registry index image that is populated with the mock devfile registry data under `tests/registry/`.
 
 Once the container has been pushed, you can push it to a container registry of your choosing with the following commands:

TROUBLESHOOTING.md

@@ -1,4 +1,4 @@
-# Troubelshooting the Devfile Registry
+# Troubleshooting the Devfile Registry
 
 ## Collecting Logs
 

build-tools/build.sh

@@ -1,16 +1,13 @@
+#!/bin/bash
 #
-# Copyright (c) 2020 Red Hat, Inc.
+# Copyright (c) 2020-2022 Red Hat, Inc.
 # This program and the accompanying materials are made
 # available under the terms of the Eclipse Public License 2.0
 # which is available at https://www.eclipse.org/legal/epl-2.0/
 #
 # SPDX-License-Identifier: EPL-2.0
 #
 
-#!/bin/bash
-
-# Enable extended globbing in the shell
-shopt -s extglob
 
 buildToolsFolder="$(dirname "$0")"
 generatorFolder=$buildToolsFolder/../index/generator

build_registry.sh

@@ -1,13 +1,15 @@
-#!/bin/sh
+#!/bin/bash
 
 # This script builds a devfile registry index container image based on the mock devfile registry data under tests/registry
 # This can be useful if developing components within this repository (such as the index server or build tools)
 # and want to test all of the components together
-
+shopt -s expand_aliases
 set -eux
+#set the docker alias if necessary
+. ./setenv.sh
 
 # Build the index server base image
-./index/server/build.sh
+. ./index/server/build.sh
 
 # Build the test devfile registry image
 docker build -t devfile-index:latest -f .ci/Dockerfile .

index/server/build.sh

@@ -1,7 +1,7 @@
-#!/bin/sh
+#!/bin/bash
 
 # Build the index container for the registry
-buildfolder="$(realpath $(dirname $0))"
+buildfolder="$(realpath $(dirname ${BASH_SOURCE[0]}))"
 
 # Clone the registry-support repo
 if [ -d $buildfolder/registry-viewer ]; then

setenv.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# This script aliases the docker cli if the environment variable USE_PODMAN is set to true.
+
+# default value is false if USE_PODMAN is unset or null
+podman=${USE_PODMAN:-false}
+if [ ${podman} == true ]; then
+  alias docker=podman
+  echo "setting alias docker=podman"
+fi

tests/integration/README.md

@@ -3,6 +3,8 @@
 This folder contains the integration tests for the OCI-based Devfile Registry. The tests can be run against either a remote devfile registry (such as https://registry.stage.devfile.io), or a local devfile registry running your machine (such as in Minikube, or Docker Desktop).
 
 ## Build
+If you want to run the build scripts with Podman, set the environment variable
+`export USE_PODMAN=true`
 
 The integration tests can be built to either run in a Docker container, or locally on your machine.
 

tests/integration/docker-build.sh

@@ -1,5 +1,7 @@
 #!/bin/sh
 
+#set the docker alias if necessary
+. ../../setenv.sh
 # Get the registry-library
 cp -rf ../../registry-library ./
 

tests/integration/docker-push.sh

@@ -1,4 +1,8 @@
 #!/bin/sh
+
+#set the docker alias if necessary
+. ../../setenv.sh
+
 IMAGE_TAG=$1
 docker tag devfile-registry-integration $IMAGE_TAG
 docker push $IMAGE_TAG