forked from kiali/kiali
-
Notifications
You must be signed in to change notification settings - Fork 0
/
crc-openshift.sh
executable file
·756 lines (665 loc) · 29.2 KB
/
crc-openshift.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
#!/bin/bash
##############################################################################
# crc-openshift.sh
#
# Run this script to start/stop an OpenShift 4 cluster.
#
# This script takes one command whose value is one of the following:
# start: starts the OpenShift environment
# stop: stops the OpenShift environment
# delete: deletes the OpenShift environment removing persisted data
# status: outputs the current status of the OpenShift environment
# ssh: logs into the CRC VM via ssh so you can probe in the VM
# sshoc: logs into the CRC VM via oc debug so you can probe in the VM
# routes: outputs all known route URLs
# services: outputs all known service endpoints (excluding internal openshift services)
# expose: creates firewalld rules so remote clients can access the cluster
# unexpose: removes firewalld rules so remote clients cannot access the cluster
#
# This script accepts several options - see --help for details.
#
# This script utilizes the crc tool and its bundle.
# If you do not have it, this script will download it for you.
# Downloading will take some time, the images are large.
#
##############################################################################
infomsg() {
echo "HACK: $1"
}
debug() {
if [ "$_VERBOSE" == "true" ]; then
infomsg "DEBUG: $1"
fi
}
get_downloader() {
if [ -z "$DOWNLOADER" ] ; then
# Use wget command if available, otherwise try curl
if which wget > /dev/null 2>&1 ; then
DOWNLOADER="wget -O"
else
if which curl > /dev/null 2>&1 ; then
DOWNLOADER="curl -L -o"
fi
fi
if [ ! "$DOWNLOADER" ] ; then
infomsg "ERROR: You must install either curl or wget to allow downloading."
exit 1
fi
fi
debug "Downloader command to be used: ${DOWNLOADER}"
}
check_crc_running() {
if [ -z ${_CRC_RUNNING} ]; then
if crc status | grep "CRC VM:.*Running" > /dev/null 2>&1; then
_CRC_RUNNING="true"
else
_CRC_RUNNING="false"
fi
debug "CRC running status: ${_CRC_RUNNING}"
fi
}
get_console_url() {
CONSOLE_URL="$(${CRC_OC} get console cluster -o jsonpath='{.status.consoleURL}' 2>/dev/null)"
if [ "$?" != "0" -o "$CONSOLE_URL" == "" ]; then
CONSOLE_URL="console-not-available"
fi
}
get_api_server_url() {
OPENSHIFT_API_SERVER_URL="$(${CRC_OC} whoami --show-server 2>/dev/null || echo 'https://api.crc.testing:6443')"
}
get_status() {
check_crc_running
echo "====================================================================="
echo "oc: ${CRC_OC}"
echo "crc: ${CRC_COMMAND}"
echo "====================================================================="
echo "Version from crc command [${CRC_COMMAND}]"
${CRC_COMMAND} version
echo "====================================================================="
echo "Status from crc command [${CRC_COMMAND}]"
${CRC_COMMAND} status
echo "====================================================================="
if [ "${_CRC_RUNNING}" == "true" ]; then
get_registry_names
get_console_url
get_api_server_url
echo "To install 'oc' in your environment:"
${CRC_COMMAND} oc-env
echo "====================================================================="
echo "Version from oc command [${CRC_OC}]"
${CRC_OC} version
echo "====================================================================="
echo "Status from oc command [${CRC_OC}]"
${CRC_OC} status
echo "====================================================================="
echo "TOP output:"
printf "%s\n" "$(exec_ssh 'top -b -n 1 | head -n 5')"
echo "====================================================================="
echo "Memory usage:"
printf "%s\n" "$(exec_ssh 'free -ht')"
echo "====================================================================="
echo "Number of CPUs: $(${CRC_OC} get $(${CRC_OC} get nodes -o name) -o jsonpath={.status.capacity.cpu})"
echo "====================================================================="
echo "Age of cluster: $(${CRC_OC} get namespace kube-system --no-headers | tr -s ' ' | cut -d ' ' -f3)"
echo "Uptime of VM: $(exec_ssh 'uptime --pretty') (since $(exec_ssh 'uptime --since'))"
echo "====================================================================="
echo "whoami: $(${CRC_OC_BIN} whoami 2>&1) ($(${CRC_OC_BIN} whoami --show-server 2>&1))"
echo "====================================================================="
echo "Console: ${CONSOLE_URL}"
echo "API URL: ${OPENSHIFT_API_SERVER_URL}"
echo "IP address: $(${CRC_COMMAND} ip)"
echo "Image Repo: ${EXTERNAL_IMAGE_REGISTRY} (${INTERNAL_IMAGE_REGISTRY})"
echo "====================================================================="
echo "kubeadmin password: $(cat ${CRC_KUBEADMIN_PASSWORD_FILE})"
echo "$(${CRC_COMMAND} console --credentials)"
echo "====================================================================="
echo "To push images to the image repo you need to log in."
echo "You can use docker or podman, and you can use kubeadmin or kiali user."
echo " oc login -u kubeadmin -p $(cat ${CRC_KUBEADMIN_PASSWORD_FILE}) ${OPENSHIFT_API_SERVER_URL}"
echo ' docker login -u kubeadmin -p $(oc whoami -t)' ${EXTERNAL_IMAGE_REGISTRY}
echo "or"
echo " oc login -u kiali -p kiali ${OPENSHIFT_API_SERVER_URL}"
echo ' podman login --tls-verify=false -u kiali -p $(oc whoami -t)' ${EXTERNAL_IMAGE_REGISTRY}
echo "====================================================================="
fi
}
get_registry_names() {
local ext="not running"
local int="not running"
check_crc_running
if [ "${_CRC_RUNNING}" == "true" ]; then
ext=$(${CRC_OC} get image.config.openshift.io/cluster -o custom-columns=EXT:.status.externalRegistryHostnames[0] --no-headers 2>/dev/null)
int=$(${CRC_OC} get image.config.openshift.io/cluster -o custom-columns=INT:.status.internalRegistryHostname --no-headers 2>/dev/null)
fi
EXTERNAL_IMAGE_REGISTRY=${ext:-<unknown>}
INTERNAL_IMAGE_REGISTRY=${int:-<unknown>}
}
get_route_url() {
# takes as input "routeName:routeNamespace"
local routename=$(echo ${1} | cut -d: -f1)
local routenamespace=$(echo ${1} | cut -d: -f2)
local protocol="https"
local termination=$(${CRC_OC} get route ${routename} -n ${routenamespace} -o custom-columns=T:spec.tls.termination --no-headers)
if [ "${termination}" == "<none>" ]; then
protocol="http"
fi
local host=$(${CRC_OC} get route ${routename} -n ${routenamespace} -o custom-columns=H:spec.host --no-headers)
ROUTE_URL="${protocol}://${host}"
}
print_all_route_urls() {
allnames_namespaces="$(${CRC_OC} get routes --all-namespaces --no-headers -o custom-columns=NAME:.metadata.name,NS:.metadata.namespace | sed ${SEDOPTIONS} 's/ */:/g')"
for n in ${allnames_namespaces}
do
get_route_url ${n}
printf '=====\n%s\n %s\n' "${n}" "${ROUTE_URL}"
done
}
get_service_endpoint() {
# takes as input "serviceName:serviceNamespace"
local servicename=$(echo ${1} | cut -d: -f1)
local servicenamespace=$(echo ${1} | cut -d: -f2)
local data="$(${CRC_OC} get service ${servicename} -n ${servicenamespace} -o custom-columns=I:spec.clusterIP,T:spec.type,NP:spec.ports[*].nodePort,P:spec.ports[*].port --no-headers | sed ${SEDOPTIONS} 's/ */:/g')"
local clusterIP=$(echo ${data} | cut -d: -f1)
local servicetype=$(echo ${data} | cut -d: -f2)
local nodeports=$(echo ${data} | cut -d: -f3)
local ports=$(echo ${data} | cut -d: -f4)
local host="$(${CRC_COMMAND} ip)"
# really only NodePort services are exposed outside of the CRC VM, so we just report those
if [ ${servicetype} == "NodePort" ]; then
SERVICE_ENDPOINT="${host}:${nodeports}"
else
if [ "${nodeports}" == "<none>" ]; then
SERVICE_ENDPOINT="inaccessible - (${servicetype}) ${clusterIP}, ports=${ports}"
else
SERVICE_ENDPOINT="inaccessible - (${servicetype}) ${clusterIP}, ports=${nodeports}"
fi
fi
}
print_all_service_endpoints() {
# we do filter out services from the internal openshift* and default namespaces
allnames_namespaces="$(${CRC_OC} get services --all-namespaces --no-headers -o custom-columns=NAME:.metadata.name,NS:.metadata.namespace | sed ${SEDOPTIONS} 's/ */:/g' | grep -v ':openshift*' | grep -v ':default')"
for n in ${allnames_namespaces}
do
get_service_endpoint ${n}
printf '=====\n%s\n %s\n' "${n}" "${SERVICE_ENDPOINT}"
done
}
exec_ssh() {
local sshcmd=${1}
ssh -y -i ${CRC_ROOT_DIR}/machines/crc/id_ecdsa -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null core@$(${CRC_COMMAND} ip) ${sshcmd}
}
expose_cluster() {
local virt_interface="crc"
local crc_ip="$(${CRC_COMMAND} ip 2>/dev/null)"
local sudo=$(test "$(whoami)" = "root" && echo "" || echo "sudo")
# make sure the platform has all the requirements needed to do this
local ip_fwd=$(cat /proc/sys/net/ipv4/ip_forward)
if [ "$ip_fwd" != "1" ]; then infomsg "ERROR: IP forwarding not enabled. /proc/sys/net/ipv4/ip_forward=$ip_fwd"; exit 1; fi
if ! which firewall-cmd >& /dev/null; then infomsg "ERROR: You do not have firewall-cmd in your PATH"; exit 1; fi
if ! systemctl -q is-active firewalld; then infomsg "ERROR: firewalld is not running"; exit 1; fi
if [ -z "${crc_ip}" ]; then infomsg "ERROR: The CRC cluster is not running"; exit 1; fi
# If we already have existing port forwards, abort
local existing_fwds=$($sudo firewall-cmd --list-forward-ports | grep "^port=80:proto=tcp:\|^port=443:proto=tcp:\|^port=6443:proto=tcp:")
if [ -n "$existing_fwds" ]; then
infomsg "ERROR: Existing port forwarding rules were found which are conflicting and must be deleted:"
for x in ${existing_fwds}; do
echo " $sudo firewall-cmd --remove-forward-port=\"$x\""
done
infomsg "You can use the 'unexpose' command to remove these rules."
exit 1
fi
for c in \
"firewall-cmd --add-forward-port=port=443:proto=tcp:toaddr=${crc_ip}:toport=443" \
"firewall-cmd --add-forward-port=port=6443:proto=tcp:toaddr=${crc_ip}:toport=6443" \
"firewall-cmd --add-forward-port=port=80:proto=tcp:toaddr=${crc_ip}:toport=80" \
"firewall-cmd --direct --passthrough ipv4 -I FORWARD -i ${virt_interface} -j ACCEPT" \
"firewall-cmd --direct --passthrough ipv4 -I FORWARD -o ${virt_interface} -j ACCEPT"
do
echo -n "EXECUTING: $sudo $c ... "
$sudo $c
done
infomsg "When accessing this cluster from outside make sure that cluster FQDNs resolve from outside."
infomsg "For basic api/console access, something like the following in an /etc/hosts entry should work:"
infomsg "<IP-of-this-host> api.crc.testing console-openshift-console.apps-crc.testing default-route-openshift-image-registry.apps-crc.testing oauth-openshift.apps-crc.testing"
}
unexpose_cluster() {
local sudo=$(test "$(whoami)" = "root" && echo "" || echo "sudo")
# make sure the platform has all the requirements needed to do this
local ip_fwd=$(cat /proc/sys/net/ipv4/ip_forward)
if [ "$ip_fwd" != "1" ]; then infomsg "ERROR: IP forwarding not enabled. /proc/sys/net/ipv4/ip_forward=$ip_fwd"; exit 1; fi
if ! which firewall-cmd >& /dev/null; then infomsg "ERROR: You do not have firewall-cmd in your PATH"; exit 1; fi
if ! systemctl -q is-active firewalld; then infomsg "ERROR: firewalld is not running"; exit 1; fi
local existing_fwds=$($sudo firewall-cmd --list-forward-ports | grep "^port=80:proto=tcp:\|^port=443:proto=tcp:\|^port=6443:proto=tcp:")
if [ -n "${existing_fwds}" ]; then
for x in ${existing_fwds}; do
echo -n "EXECUTING: $sudo firewall-cmd --remove-forward-port=\"$x\" ... "
$sudo firewall-cmd --remove-forward-port="$x"
done
else
echo "No relevant firewalld rules exist - nothing needs to be removed."
fi
}
# Change to the directory where this script is and set our environment
SCRIPT_ROOT="$( cd "$(dirname "$0")" ; pwd -P )"
cd ${SCRIPT_ROOT}
# The default version of the crc tool to be downloaded
DEFAULT_CRC_DOWNLOAD_VERSION="2.23.0"
# The default version of the crc bundle - this is typically the version included with the CRC download
DEFAULT_CRC_LIBVIRT_DOWNLOAD_VERSION="4.13.3"
# The default virtual CPUs assigned to the CRC VM
DEFAULT_CRC_CPUS="5"
# The default memory (in GB) assigned to the CRC VM
DEFAULT_CRC_MEMORY="16"
# The default virtual disk size (in GB) assigned to the CRC VM
DEFAULT_CRC_VIRTUAL_DISK_SIZE="31"
# If true the OpenShift bundle will be downloaded when needed.
DEFAULT_DOWNLOAD_BUNDLE="false"
# Enables cluster monitoring in the CRC cluster
DEFAULT_ENABLE_CLUSTER_MONITORING="false"
# process command line args to override environment
_CMD=""
while [[ $# -gt 0 ]]; do
key="$1"
case $key in
start|up)
_CMD="start"
shift
;;
stop|down)
_CMD="stop"
shift
;;
delete)
_CMD="delete"
shift
;;
status)
_CMD="status"
shift
;;
ssh)
_CMD="ssh"
shift
;;
sshoc)
_CMD="sshoc"
shift
;;
routes)
_CMD="routes"
shift
;;
services)
_CMD="services"
shift
;;
expose)
_CMD="expose"
shift
;;
unexpose)
_CMD="unexpose"
shift
;;
-b|--bin-dir)
OPENSHIFT_BIN_PATH="$2"
shift;shift
;;
-ca|--crc-arch)
CRC_DOWNLOAD_ARCH="$2"
shift;shift
;;
-clv|--crc-libvirt-version)
CRC_LIBVIRT_DOWNLOAD_VERSION="$2"
shift;shift
;;
-ccpus|--crc-cpus)
CRC_CPUS="$2"
shift;shift
;;
-cmem|--crc-memory)
CRC_MEMORY="$2"
shift;shift
;;
-cp|--crc-platform)
CRC_DOWNLOAD_PLATFORM="$2"
shift;shift
;;
-cv|--crc-version)
CRC_DOWNLOAD_VERSION="$2"
shift;shift
;;
-cvdisk|--crc-virtual-disk-size)
CRC_VIRTUAL_DISK_SIZE="$2"
shift;shift
;;
-db|--download-bundle)
DOWNLOAD_BUNDLE="$2"
shift;shift
;;
-ecm|--enable-cluster-monitoring)
ENABLE_CLUSTER_MONITORING="$2"
shift;shift
;;
-p|--pull-secret-file)
PULL_SECRET_FILE="$2"
shift;shift
;;
-v|--verbose)
_VERBOSE=true
shift
;;
-h|--help)
cat <<HELPMSG
$0 [option...] command
Valid options:
-b|--bin-dir <dir>
Directory where the OpenShift binaries are or will be stored when downloaded.
Default: ${HOME}/bin
-ca|--crc-arch <architecture>
The architecture of the crc binary to use.
Default: amd64
-clv|--crc-libvirt-version <version>
The version of the crc libvirt bundle to use.
If one does not exist in the bin directory, it will be downloaded there.
Default: ${DEFAULT_CRC_LIBVIRT_DOWNLOAD_VERSION}
-ccpus|--crc-cpus <num CPUs>
Number of virtual CPUs to assign to the VM.
Default: ${DEFAULT_CRC_CPUS}
Used only for the 'start' command.
-cmem|--crc-memory <memory size>
Amount of memory (in GB) to assign to the VM.
Default: ${DEFAULT_CRC_MEMORY}
Used only for the 'start' command.
-cp|--crc-platform <platform>
The platform indicator to determine what crc binary to download.
Default: linux (darwin if Mac is detected)
-cv|--crc-version <version>
The version of the crc binary to use.
If one does not exist in the bin directory, it will be downloaded there.
Default: ${DEFAULT_CRC_DOWNLOAD_VERSION}
-cvdisk|--crc-virtual-disk-size <disk size>
The size of the virtual disk (in GB) to assign to the VM.
Default: ${DEFAULT_CRC_VIRTUAL_DISK_SIZE}
Used only for the 'start' command.
-db|--download-bundle (true|false)
If true, the OpenShift bundle image will be downloaded by this script if needed.
You usually do not need to set this to true - crc itself will download the bundle if it is needed.
Default: ${DEFAULT_DOWNLOAD_BUNDLE}
Used only for the 'start' command.
-ecm|--enable-cluster-monitoring (true|false)
If true, the cluster will have monitoring enabled.
Default: ${DEFAULT_ENABLE_CLUSTER_MONITORING}
Used only for the 'start' command.
-h|--help : this message
-p|--pull-secret-file <filename>
Specifies the file containing your Image pull secret.
You can download it from https://cloud.redhat.com/openshift/install/metal/user-provisioned
CRC will ignore this if the pull secret was already installed during a previous start.
Used only for the 'start' command.
Default: not set (you will be prompted for the pull secret json at startup if it does not exist yet)
-v|--verbose
Enable logging of debug messages from this script.
The command must be one of:
* start: Starts the CRC VM with OpenShift 4.x.
* stop: Stops the CRC VM retaining all data. 'start' will then bring up the CRC VM in the same state.
* delete: Stops the CRC VM and removes all persistent data. 'start' will then bring up a clean CRC VM.
* status: Information about the CRC VM and the OpenShift cluster running inside it.
* ssh: Provides a command line prompt with root access inside the CRC VM. Logs in via ssh.
* sshoc: Provides a command line prompt with root access inside the CRC VM. Logs in via oc debug.
* routes: Outputs URLs for all known routes.
* services: Outputs URLs for all known service endpoints (excluding internal openshift services).
* expose: Creates firewalld rules so remote clients can access the cluster.
* unexpose: Removes firewalld rules so remote clients cannot access the cluster.
HELPMSG
exit 1
;;
*)
infomsg "Unknown argument [$key]. Aborting."
exit 1
;;
esac
done
########################################
# Environment setup section starts here.
#--------------------------------------------------------------
# Variables below have values that can be overridden by
# command line options (see above) or by environment variables.
#--------------------------------------------------------------
# if sed is gnu-sed then set option to work in posix mode to be compatible with non-gnu-sed versions
if sed --posix 's/ / /' < /dev/null > /dev/null 2>&1 ; then
SEDOPTIONS="--posix"
fi
# This is where you want the OpenShift binaries to go
OPENSHIFT_BIN_PATH="${OPENSHIFT_BIN_PATH:=${HOME}/bin}"
# The platform is either "linux" or "darwin".
DEFAULT_OS_PLATFORM=linux
DETECTED_OS_PLATFORM=`uname | tr '[:upper:]' '[:lower:]'`
if [ "${DETECTED_OS_PLATFORM}" = "linux" -o "${DETECTED_OS_PLATFORM}" = "darwin" ] ; then
DEFAULT_OS_PLATFORM=${DETECTED_OS_PLATFORM}
debug "The operating system has been detected as ${DEFAULT_OS_PLATFORM}"
fi
CRC_DOWNLOAD_VERSION="${CRC_DOWNLOAD_VERSION:-${DEFAULT_CRC_DOWNLOAD_VERSION}}"
CRC_DOWNLOAD_PLATFORM="${CRC_DOWNLOAD_PLATFORM:-${DEFAULT_OS_PLATFORM}}"
CRC_DOWNLOAD_ARCH="${CRC_DOWNLOAD_ARCH:-amd64}"
CRC_LIBVIRT_DOWNLOAD_VERSION="${CRC_LIBVIRT_DOWNLOAD_VERSION:-${DEFAULT_CRC_LIBVIRT_DOWNLOAD_VERSION}}"
CRC_ROOT_DIR="${HOME}/.crc"
CRC_KUBEADMIN_PASSWORD_FILE="${CRC_ROOT_DIR}/machines/crc/kubeadmin-password"
CRC_KUBECONFIG="${CRC_ROOT_DIR}/machines/crc/kubeconfig"
CRC_MACHINE_IMAGE="${CRC_ROOT_DIR}/machines/crc/crc"
CRC_OC_BIN="${CRC_ROOT_DIR}/bin/oc/oc"
DOWNLOAD_BUNDLE="${DOWNLOAD_BUNDLE:-${DEFAULT_DOWNLOAD_BUNDLE}}"
ENABLE_CLUSTER_MONITORING="${ENABLE_CLUSTER_MONITORING:-${DEFAULT_ENABLE_CLUSTER_MONITORING}}"
# VM configuration
CRC_CPUS=${CRC_CPUS:-${DEFAULT_CRC_CPUS}}
CRC_MEMORY=${CRC_MEMORY:-${DEFAULT_CRC_MEMORY}}
CRC_VIRTUAL_DISK_SIZE=${CRC_VIRTUAL_DISK_SIZE:-${DEFAULT_CRC_VIRTUAL_DISK_SIZE}}
#--------------------------------------------------------------
# Variables below have values derived from the variables above.
# These variables below are not meant for users to change.
#--------------------------------------------------------------
# Determine where to get the binaries and their full paths and how to execute them.
# To see versions of crc and openshift, go to either:
# * http://cdk-builds.usersys.redhat.com/builds/crc/releases
# * https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/crc
# Pick a version, and drill down into release-info.json - it will tell you what OpenShift it has inside, for example.
#CRC_DOWNLOAD_LOCATION="https://mirror.openshift.com/pub/openshift-v4/clients/crc/${CRC_DOWNLOAD_VERSION}/crc-${CRC_DOWNLOAD_PLATFORM}-${CRC_DOWNLOAD_ARCH}.tar.xz"
CRC_DOWNLOAD_LOCATION="https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/crc/${CRC_DOWNLOAD_VERSION}/crc-${CRC_DOWNLOAD_PLATFORM}-${CRC_DOWNLOAD_ARCH}.tar.xz"
CRC_DOWNLOAD_LOCATION_ALT="http://cdk-builds.usersys.redhat.com/builds/crc/releases/${CRC_DOWNLOAD_VERSION}/crc-${CRC_DOWNLOAD_PLATFORM}-${CRC_DOWNLOAD_ARCH}.tar.xz"
CRC_EXE_NAME=crc
CRC_EXE_PATH="${OPENSHIFT_BIN_PATH}/${CRC_EXE_NAME}"
CRC_COMMAND="${CRC_EXE_PATH}"
if [ "${_VERBOSE}" == "true" ]; then
CRC_COMMAND="${CRC_COMMAND} --log-level debug"
fi
CRC_LIBVIRT_DOWNLOAD_LOCATION="https://mirror.openshift.com/pub/openshift-v4/clients/crc/bundles/openshift/${CRC_LIBVIRT_DOWNLOAD_VERSION}/crc_libvirt_${CRC_LIBVIRT_DOWNLOAD_VERSION}_${CRC_DOWNLOAD_ARCH}.crcbundle"
CRC_LIBVIRT_PATH="${OPENSHIFT_BIN_PATH}/crc_libvirt_${CRC_LIBVIRT_DOWNLOAD_VERSION}_${CRC_DOWNLOAD_ARCH}.crcbundle"
CRC_OC="${CRC_OC_BIN} --kubeconfig ${CRC_KUBECONFIG}"
# Environment setup section stops here.
########################################
debug "ENVIRONMENT:
command=$_CMD
CRC_COMMAND=$CRC_COMMAND
CRC_CPUS=$CRC_CPUS
CRC_DOWNLOAD_LOCATION=$CRC_DOWNLOAD_LOCATION
CRC_DOWNLOAD_LOCATION_ALT=$CRC_DOWNLOAD_LOCATION_ALT
CRC_DOWNLOAD_PLATFORM=$CRC_DOWNLOAD_PLATFORM
CRC_DOWNLOAD_VERSION=$CRC_DOWNLOAD_VERSION
CRC_EXE_NAME=$CRC_EXE_NAME
CRC_EXE_PATH=$CRC_EXE_PATH
CRC_KUBEADMIN_PASSWORD_FILE=$CRC_KUBEADMIN_PASSWORD_FILE
CRC_KUBECONFIG=$CRC_KUBECONFIG
CRC_LIBVIRT_DOWNLOAD_LOCATION=$CRC_LIBVIRT_DOWNLOAD_LOCATION
CRC_LIBVIRT_DOWNLOAD_VERSION=$CRC_LIBVIRT_DOWNLOAD_VERSION
CRC_LIBVIRT_PATH=$CRC_LIBVIRT_PATH
CRC_MACHINE_IMAGE=$CRC_MACHINE_IMAGE
CRC_MEMORY=$CRC_MEMORY
CRC_OC=$CRC_OC
CRC_ROOT_DIR=$CRC_ROOT_DIR
CRC_VIRTUAL_DISK_SIZE=$CRC_VIRTUAL_DISK_SIZE
ENABLE_CLUSTER_MONITORING=$ENABLE_CLUSTER_MONITORING
OPENSHIFT_BIN_PATH=$OPENSHIFT_BIN_PATH
"
# Fail fast if we don't even have the correct location where the oc client should be
if [ ! -d "${OPENSHIFT_BIN_PATH}" ]; then
infomsg "ERROR: You must define OPENSHIFT_BIN_PATH to an existing location where you want the downloaded tools to be. It is currently set to: ${OPENSHIFT_BIN_PATH}"
exit 1
fi
# Download the crc tool if we do not have it yet
if [ -f "${CRC_EXE_PATH}" ]; then
_existingVersion=$(${CRC_EXE_PATH} version 2>/dev/null | head -n 1 | sed ${SEDOPTIONS} "s/^C.*: \([A-Za-z0-9.]*\)[A-Za-z0-9.-]*+[a-z0-9]*$/\1/")
_crc_major_minor_patch_version="$(echo -n ${CRC_DOWNLOAD_VERSION} | sed -E 's/([0-9]+.[0-9]+.[0-9]+).*/\1/')"
if [ "${_existingVersion}" != "${CRC_DOWNLOAD_VERSION}" -a "${_existingVersion}" != "${_crc_major_minor_patch_version}" ]; then
infomsg "===== WARNING ====="
infomsg "You already have the crc tool but it does not match the version you want."
infomsg "Either delete your existing binary and let this script download another one,"
infomsg "or change the version passed to this script to match the version of your crc tool."
infomsg "crc is here: ${CRC_EXE_PATH}"
infomsg "The version of the crc binary is: ${_existingVersion}"
infomsg "You asked for version: ${CRC_DOWNLOAD_VERSION}"
infomsg "===== WARNING ====="
exit 1
fi
else
infomsg "Downloading crc binary to ${CRC_EXE_PATH}"
get_downloader
eval ${DOWNLOADER} "${CRC_EXE_PATH}.tar.xz" ${CRC_DOWNLOAD_LOCATION}
if [ "$?" != "0" ]; then
eval ${DOWNLOADER} "${CRC_EXE_PATH}.tar.xz" ${CRC_DOWNLOAD_LOCATION_ALT}
if [ "$?" != "0" ]; then
infomsg "===== WARNING ====="
infomsg "Could not download the client binary for the version you want."
infomsg "Make sure this is valid: ${CRC_DOWNLOAD_LOCATION}"
infomsg "Or this is valid: ${CRC_DOWNLOAD_LOCATION_ALT}"
infomsg "===== WARNING ====="
rm "${CRC_EXE_PATH}.tar.xz"
exit 1
fi
fi
tar xvf "${CRC_EXE_PATH}.tar.xz" --wildcards -C "$(dirname ${CRC_EXE_PATH})" --strip 1 '*/crc'
chmod +x ${CRC_EXE_PATH}
rm "${CRC_EXE_PATH}.tar.xz"
fi
debug "crc command that will be used: ${CRC_COMMAND}"
debug "$(${CRC_COMMAND} version)"
# Download the crc libvirt image if we do not have it yet
if [ "${DOWNLOAD_BUNDLE}" == "true" ]; then
CRC_BUNDLE_FILE="${CRC_LIBVIRT_PATH}"
if [ -f "${CRC_LIBVIRT_PATH}" ]; then
debug "crc libvirt bundle that will be used: ${CRC_LIBVIRT_PATH}"
elif [ "$(stat -c '%s' ${CRC_EXE_PATH})" -gt "1000000000" ]; then
debug "crc appears to have the bundle already included. It will be used: $(stat -c '%n (%s bytes)' ${CRC_EXE_PATH})"
CRC_BUNDLE_FILE=""
else
infomsg "Downloading crc libvirt bundle to ${CRC_LIBVIRT_PATH}"
get_downloader
eval ${DOWNLOADER} "${CRC_LIBVIRT_PATH}" ${CRC_LIBVIRT_DOWNLOAD_LOCATION}
if [ "$?" != "0" ]; then
infomsg "===== WARNING ====="
infomsg "Could not download the crc libvirt bundle."
infomsg "Make sure this is valid: ${CRC_LIBVIRT_DOWNLOAD_LOCATION}"
infomsg "===== WARNING ====="
rm "${CRC_LIBVIRT_PATH}"
exit 1
fi
fi
else
CRC_BUNDLE_FILE=""
infomsg "Was asked to not download the crc libvirt bundle"
fi
cd ${OPENSHIFT_BIN_PATH}
if [ "$_CMD" = "start" ]; then
infomsg "Defining the CRC configuration..."
if [ ! -z "${CRC_BUNDLE_FILE}" ]; then
${CRC_COMMAND} config set bundle ${CRC_BUNDLE_FILE}
else
${CRC_COMMAND} config unset bundle
fi
${CRC_COMMAND} config set consent-telemetry no
${CRC_COMMAND} config set cpus ${CRC_CPUS}
${CRC_COMMAND} config set disable-update-check true
${CRC_COMMAND} config set disk-size ${CRC_VIRTUAL_DISK_SIZE}
${CRC_COMMAND} config set enable-cluster-monitoring ${ENABLE_CLUSTER_MONITORING}
${CRC_COMMAND} config set kubeadmin-password kiali
${CRC_COMMAND} config set memory $(expr ${CRC_MEMORY} '*' 1024)
if [ ! -z "${PULL_SECRET_FILE}" ]; then
${CRC_COMMAND} config set pull-secret-file ${PULL_SECRET_FILE}
else
${CRC_COMMAND} config unset pull-secret-file
fi
# Unsure if we need these
#${CRC_COMMAND} config set network-mode user
#${CRC_COMMAND} config set host-network-access true
infomsg "Setting up the requirements for the OpenShift cluster..."
debug "${CRC_COMMAND} setup"
${CRC_COMMAND} setup
if [ "$?" != "0" ]; then
infomsg "ERROR: failed to setup the requirements for OpenShift."
exit 1
fi
infomsg "Starting the OpenShift cluster..."
debug "${CRC_COMMAND} start"
${CRC_COMMAND} start
if [ "$?" != "0" ]; then
infomsg "ERROR: failed to start the VM."
exit 1
fi
${CRC_OC} login -u kubeadmin -p $(cat ${CRC_KUBEADMIN_PASSWORD_FILE})
# see https://docs.openshift.com/container-platform/4.8/authentication/identity_providers/configuring-htpasswd-identity-provider.html
# we need to be admin in order to create the htpasswd oauth and users
if which htpasswd; then
infomsg "Creating user 'kiali'"
${CRC_OC} get secret -n openshift-config htpass-secret -o jsonpath={.data.htpasswd} | base64 -d | sed -e '$a\' > /tmp/crc.htpasswd.kiali && htpasswd -b /tmp/crc.htpasswd.kiali kiali kiali
${CRC_OC} patch secret -n openshift-config htpass-secret --patch '{"data": {"htpasswd": "'$(cat /tmp/crc.htpasswd.kiali | base64 -w 0)'" }}'
rm /tmp/crc.htpasswd.kiali
# Add cluster role to the kiali user once it that user is available
for i in {1..20}
do
infomsg "Waiting for kiali user to be created before attempting to assign it cluster-admin role..."
sleep 10
if ${CRC_OC} login -u kiali -p kiali &>/dev/null; then
infomsg "Will assign the cluster-admin role to the kiali user."
${CRC_OC} login -u kubeadmin -p $(cat ${CRC_KUBEADMIN_PASSWORD_FILE})
${CRC_OC} adm policy add-cluster-role-to-user cluster-admin kiali
break
fi
done
else
echo "Not adding user 'kiali' because you do not have htpasswd installed - use the default users that come with CRC"
fi
# Make sure the image registry is exposed via the default route
if [ "$(${CRC_OC} get config.imageregistry.operator.openshift.io/cluster -o jsonpath='{.spec.defaultRoute}')" != "true" ]; then
infomsg "Manually patching image registry operator to expose the internal image registry"
${CRC_OC} patch config.imageregistry.operator.openshift.io/cluster --patch '{"spec":{"defaultRoute":true}}' --type=merge
else
debug "The image registry operator has exposed the internal image registry"
fi
# show the status message
get_status
elif [ "$_CMD" = "stop" ]; then
infomsg "Will shutdown the OpenShift cluster."
${CRC_COMMAND} stop
elif [ "$_CMD" = "delete" ]; then
infomsg "Will delete the OpenShift cluster - this removes all persisted data."
${CRC_COMMAND} delete --clear-cache --force
infomsg "If CRC is not cleaned up fully, execute: sudo virsh destroy crc && sudo virsh undefine crc"
elif [ "$_CMD" = "status" ]; then
get_status
elif [ "$_CMD" = "ssh" ]; then
infomsg "Logging into the CRC VM via ssh..."
exec_ssh ""
elif [ "$_CMD" = "sshoc" ]; then
infomsg "Logging into the CRC VM via oc debug..."
${CRC_OC} debug $(${CRC_OC} get nodes -o name)
elif [ "$_CMD" = "routes" ]; then
print_all_route_urls
elif [ "$_CMD" = "services" ]; then
print_all_service_endpoints
elif [ "$_CMD" = "expose" ]; then
expose_cluster
elif [ "$_CMD" = "unexpose" ]; then
unexpose_cluster
else
infomsg "ERROR: Required command must be either: start, stop, delete, status, ssh, sshoc, routes, services, expose, unexpose"
exit 1
fi