Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature: add ABM admin cluster script #459

Merged
merged 7 commits into from
Oct 24, 2022
Merged

feature: add ABM admin cluster script #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
40ace4e
feature: add admin cluster script
Shabirmean Oct 22, 2022
9942d2a
fix: pr ncomments
Shabirmean Oct 22, 2022
34555b5
fix: update output
Shabirmean Oct 22, 2022
6e8a064
doc: fix link error
Shabirmean Oct 22, 2022
22062cf
lint: fix whitespace
Shabirmean Oct 22, 2022
871bbab
doc: remove unnecessary output
Shabirmean Oct 22, 2022
712a5c4
doc: fix lint errors
Shabirmean Oct 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 8 additions & 114 deletions anthos-bm-gcp-bash/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,123 +1,17 @@
## Anthos Baremetal on Google Compute Engine VMs

This sample shows you how to setup an Anthos clusters on bare metal in High
Availability (HA) mode using Compute Engine Virtual Machines (VMs). The
[setup_and_install_abm](./setup_and_install_abm.sh) script encapsulates all
the steps required to setup the Compute Engine VMs and to trigger the
installation of Anthos on bare metal. Follow the
[Try Anthos clusters on bare metal on Compute Engine VMs](https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/try/gce-vms) guide for a step by step
explanation of all the steps included in this script.
The scripts here show how to setup various types of
_(e.g. hybrid, admin, user, standalone)_ Anthos clusters on bare metal in
Compute Engine Virtual Machines (VMs). Select the guide for the type of cluster
you want to install and follow the guide.

- [Setup and install a **hybrid** Anthos on bare metal cluster](./docs/hybrid.md)
- [Setup and install a **admin** Anthos on bare metal cluster](./docs/admin.md)

### Prerequisites

- A workstation with access to the Internet _(i.e. Google Cloud APIs)_ with the following installed
- [Git](https://git-scm.com/)
- [Google Cloud SDK (gcloud CLI)](https://cloud.google.com/sdk/docs/install)
- A [Google Cloud Project](https://console.cloud.google.com/cloud-resource-manager?_ga=2.187862184.1029435410.1614837439-1338907320.1614299892) _(in which the resources for the setup will be provisioned)_
- The gcloud CLI must be [authenticated to Google Cloud and be configured to use
the Google Cloud Project](https://cloud.google.com/sdk/gcloud/reference/init) you intend to use
---
### Quickstart

The steps inside the script is written with the assumption that you are working
with a Google Cloud Project that has most of the default settings. This is to
keep the different customizations to a minimal and allow for anyone to start at
this baseline and make changes as required. Based on the popularity of certain
variations, information about them are explained in the [FAQ](./FAQ.md) section.

1. Clone this repo into the workstation from where the rest of this guide will
be followed.

```sh
git clone https://github.com/GoogleCloudPlatform/anthos-samples
cd anthos-bm-gcp-bash
```

2. Setup environment variables.
```sh
export PROJECT_ID=<GCP_PROJECT_TO_USE>
export ZONE=<GCP_ZONE_TO_USE>
```

3. Run the installation script.

```sh
bash setup_and_install_abm.sh
```
```sh
# expected output
...
...
...
✅ Successfully set up SSH access from admin workstation to cluster node VMs.

🔄 Installing Anthos on bare metal...
Your active configuration is: [shabir-shell-check2]
Pseudo-terminal will not be allocated because stdin is not a terminal.
Enter passphrase for key '/Users/shabirmean/.ssh/google_compute_engine':
Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.15.0-1018-gcp x86_64)

* Documentation: https://help.ubuntu.com
* Management: https://landscape.canonical.com
* Support: https://ubuntu.com/advantage

System information as of Tue Oct 4 19:09:07 UTC 2022

System load: 0.39 Users logged in: 0
Usage of /: 1.3% of 193.65GB IPv4 address for docker0: 172.17.0.1
Memory usage: 1% IPv4 address for ens4: 10.128.0.2
Swap usage: 0% IPv4 address for vxlan0: 10.200.0.2
Processes: 153


0 updates can be applied immediately.

New release '22.04.1 LTS' available.
Run 'do-release-upgrade' to upgrade to it.


+ export PROJECT_ID=shabir-shell-check2
+ PROJECT_ID=shabir-shell-check2
+ export clusterid=cluster-1
+ clusterid=cluster-1
+ bmctl create config -c cluster-1
[2022-10-04 19:09:08+0000] Created config: bmctl-workspace/cluster-1/cluster-1.yaml
+ cat
+ bmctl create cluster -c cluster-1
Please check the logs at bmctl-workspace/cluster-1/log/create-cluster-20221004-190908/create-cluster.log
[2022-10-04 19:09:14+0000] Creating bootstrap cluster... OK
[2022-10-04 19:10:24+0000] Installing dependency components... OK
[2022-10-04 19:11:51+0000] Waiting for preflight check job to finish... OK
[2022-10-04 19:13:51+0000] - Validation Category: machines and network
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.5
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.6
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.7
[2022-10-04 19:13:51+0000] - [PASSED] gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.4-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.3-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.4
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.5-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.6-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.7-gcp
[2022-10-04 19:13:51+0000] - [PASSED] node-network
[2022-10-04 19:13:51+0000] - [PASSED] pod-cidr
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.3
[2022-10-04 19:13:51+0000] Flushing logs... OK
[2022-10-04 19:13:53+0000] Applying resources for new cluster
[2022-10-04 19:13:53+0000] Waiting for cluster kubeconfig to become ready OK
[2022-10-04 19:17:03+0000] Writing kubeconfig file
[2022-10-04 19:17:03+0000] kubeconfig of cluster being created is present at bmctl-workspace/cluster-1/cluster-1-kubeconfig
[2022-10-04 19:17:03+0000] Please restrict access to this file as it contains authentication credentials of your cluster.
[2022-10-04 19:17:03+0000] Waiting for cluster to become ready OK
[2022-10-04 19:23:43+0000] Please run
[2022-10-04 19:23:43+0000] kubectl --kubeconfig bmctl-workspace/cluster-1/cluster-1-kubeconfig get nodes
[2022-10-04 19:23:43+0000] to get cluster nodes status.
[2022-10-04 19:23:43+0000] Waiting for node pools to become ready OK
[2022-10-04 19:24:03+0000] Waiting for metrics to become ready in GCP OK
[2022-10-04 19:24:13+0000] Moving admin cluster resources to the created admin cluster
[2022-10-04 19:24:20+0000] Waiting for node update jobs to finish OK
[2022-10-04 19:26:40+0000] Flushing logs... OK
[2022-10-04 19:26:40+0000] Deleting bootstrap cluster... OK
✅ Installation complete. Please check the logs for any errors!!!
```
variations, information about them are explained in the [FAQ](./docs/faq.md)
section.
128 changes: 128 additions & 0 deletions anthos-bm-gcp-bash/docs/admin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
## Install an Anthos on bare metal cluster of type 'admin'

This sample shows you how to setup an **admin** Anthos clusters on bare metal
in High Availability (HA) mode using Compute Engine Virtual Machines (VMs). The
[install_admin_cluster](/anthos-bm-gcp-bash/install_admin_cluster.sh) script
encapsulates all the steps required to setup the Compute Engine VMs and to
trigger the installation of the admin cluster. The steps used for setting up the
Compute Engine VM environment in this script are the same as the ones explained
in the [Try Anthos clusters on bare metal on Compute Engine VMs](https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/try/gce-vms) guide. The only differences are the number
of Compute Engine VMs used and the cluster configuration file
_(which is specific to an admin cluster)_.

### Prerequisites

- A workstation with access to the Internet _(i.e. Google Cloud APIs)_ with the following installed
- [Git](https://git-scm.com/)
- [Google Cloud SDK (gcloud CLI)](https://cloud.google.com/sdk/docs/install)
- A [Google Cloud Project](https://console.cloud.google.com/cloud-resource-manager?_ga=2.187862184.1029435410.1614837439-1338907320.1614299892) _(in which the resources for the setup will be provisioned)_
- The gcloud CLI must be [authenticated to Google Cloud and be configured to use
the Google Cloud Project](https://cloud.google.com/sdk/gcloud/reference/init) you intend to use
---
### Quickstart

1. Clone this repo into the workstation from where the rest of this guide will
be followed.

```sh
git clone https://github.com/GoogleCloudPlatform/anthos-samples
cd anthos-samples/anthos-bm-gcp-bash
```

2. Setup environment variables.
```sh
export PROJECT_ID=<GCP_PROJECT_TO_USE>
export ZONE=<GCP_ZONE_TO_USE>
export ADMIN_CLUSTER_NAME=<NAME_FOR_THE_CLUSTER>
```

3. Run the installation script.

```sh
bash install_admin_cluster.sh
```
```sh
# expected output
...
...
...
✅ Successfully set up SSH access from admin workstation to cluster node VMs.

🔄 Installing Anthos on bare metal...
Pseudo-terminal will not be allocated because stdin is not a terminal.
Enter passphrase for key '/Users/sundarpichai/.ssh/google_compute_engine':
Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.15.0-1021-gcp x86_64)

* Documentation: https://help.ubuntu.com
* Management: https://landscape.canonical.com
* Support: https://ubuntu.com/advantage

System information as of Fri Oct 21 23:56:11 UTC 2022

System load: 0.38 Users logged in: 0
Usage of /: 1.4% of 193.65GB IPv4 address for docker0: 172.17.0.1
Memory usage: 1% IPv4 address for ens4: 10.142.0.2
Swap usage: 0% IPv4 address for vxlan0: 10.200.0.2
Processes: 157


6 updates can be applied immediately.
5 of these updates are standard security updates.
To see these additional updates run: apt list --upgradable

New release '22.04.1 LTS' available.
Run 'do-release-upgrade' to upgrade to it.


++ gcloud config get-value project
+ export PROJECT_ID=abm-ame-cluster
+ PROJECT_ID=abm-ame-cluster
++ curl http://metadata.google.internal/computeMetadata/v1/instance/attributes/cluster_id -H 'Metadata-Flavor: Google'
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 20 100 20 0 0 10000 0 --:--:-- --:--:-- --:--:-- 10000
+ ADMIN_CLUSTER_NAME=abm-ame-cluster
+ export ADMIN_CLUSTER_NAME
+ bmctl create config -c abm-ame-cluster
[2022-10-21 23:56:13+0000] Created config: bmctl-workspace/abm-ame-cluster/abm-ame-cluster.yaml
+ cat
+ bmctl create cluster -c abm-ame-cluster
Please check the logs at bmctl-workspace/abm-ame-cluster/log/create-cluster-20221021-235613/create-cluster.log
[2022-10-21 23:56:19+0000] Creating bootstrap cluster... OK
[2022-10-21 23:57:35+0000] Installing dependency components... OK
[2022-10-21 23:58:53+0000] Waiting for preflight check job to finish... OK
[2022-10-22 00:00:23+0000] - Validation Category: machines and network
[2022-10-22 00:00:23+0000] - [PASSED] node-network
[2022-10-22 00:00:23+0000] - [PASSED] pod-cidr
[2022-10-22 00:00:23+0000] - [PASSED] 10.200.0.3
[2022-10-22 00:00:23+0000] - [PASSED] 10.200.0.3-gcp
[2022-10-22 00:00:23+0000] - [PASSED] gcp
[2022-10-22 00:00:23+0000] Flushing logs... OK
[2022-10-22 00:00:25+0000] Applying resources for new cluster
[2022-10-22 00:00:25+0000] Waiting for cluster kubeconfig to become ready OK
[2022-10-22 00:03:35+0000] Writing kubeconfig file
[2022-10-22 00:03:35+0000] kubeconfig of cluster being created is present at bmctl-workspace/abm-ame-cluster/abm-ame-cluster-kubeconfig
[2022-10-22 00:03:35+0000] Please restrict access to this file as it contains authentication credentials of your cluster.
[2022-10-22 00:03:35+0000] Waiting for cluster to become ready OK
[2022-10-22 00:07:35+0000] Please run
[2022-10-22 00:07:35+0000] kubectl --kubeconfig bmctl-workspace/abm-ame-cluster/abm-ame-cluster-kubeconfig get nodes
[2022-10-22 00:07:35+0000] to get cluster nodes status.
[2022-10-22 00:07:35+0000] Waiting for node pools to become ready OK
[2022-10-22 00:07:55+0000] Waiting for metrics to become ready in GCP OK
[2022-10-22 00:08:05+0000] Moving admin cluster resources to the created admin cluster
[2022-10-22 00:08:09+0000] Waiting for node update jobs to finish OK
[2022-10-22 00:09:49+0000] Flushing logs... OK
[2022-10-22 00:09:49+0000] Deleting bootstrap cluster... OK
✅ Installation complete. Please check the logs for any errors!!!

✅ If you do not see any errors in the output log, then you now have the following setup:

|---------------------------------------------------------------------------------------------------------|
| VM Name | L2 Network IP (VxLAN) | INFO |
|---------------------------------------------------------------------------------------------------------|
| abm-admin-cluster-cp1 | 10.200.0.3 | Has control plane of admin cluster running inside |
| abm-user-cluster-cp1 | 10.200.0.4 | 🌟 Ready for use as control plane for the user cluster |
| abm-user-cluster-w1 | 10.200.0.5 | 🌟 Ready for use as worker for the user cluster |
| abm-user-cluster-w2 | 10.200.0.6 | 🌟 Ready for use as worker for the user cluster |
|---------------------------------------------------------------------------------------------------------|
```
4 changes: 2 additions & 2 deletions anthos-bm-gcp-bash/FAQ.md → anthos-bm-gcp-bash/docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ to do the following changes:
```

2. Update the command for creating Compute Engine VMs in the
[setup_and_install_abm](./setup_and_install_abm.sh) script to use the network
of your choice instead of `default`.
[install_hybrid_cluster](/anthos-bm-gcp-bash/install_admin_cluster.sh) script
to use the network of your choice instead of `default`.

```sh
...
Expand Down
117 changes: 117 additions & 0 deletions anthos-bm-gcp-bash/docs/hybrid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
## Install an Anthos on bare metal cluster of type 'hybrid'

This sample shows you how to setup an **hybrid** Anthos clusters on bare metal
in High Availability (HA) mode using Compute Engine Virtual Machines (VMs). The
[install_hybrid_cluster](/anthos-bm-gcp-bash/install_hybrid_cluster.sh) script
encapsulates all the steps required to setup the Compute Engine VMs and to
trigger the installation of Anthos on bare metal. Follow the
[Try Anthos clusters on bare metal on Compute Engine VMs](https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/try/gce-vms) guide for a step by step
explanation of all the steps included in this script.


### Prerequisites

- A workstation with access to the Internet _(i.e. Google Cloud APIs)_ with the following installed
- [Git](https://git-scm.com/)
- [Google Cloud SDK (gcloud CLI)](https://cloud.google.com/sdk/docs/install)
- A [Google Cloud Project](https://console.cloud.google.com/cloud-resource-manager?_ga=2.187862184.1029435410.1614837439-1338907320.1614299892) _(in which the resources for the setup will be provisioned)_
- The gcloud CLI must be [authenticated to Google Cloud and be configured to use
the Google Cloud Project](https://cloud.google.com/sdk/gcloud/reference/init) you intend to use
---
### Quickstart

1. Clone this repo into the workstation from where the rest of this guide will
be followed.

```sh
git clone https://github.com/GoogleCloudPlatform/anthos-samples
cd anthos-samples/anthos-bm-gcp-bash
```

2. Setup environment variables.
```sh
export PROJECT_ID=<GCP_PROJECT_TO_USE>
export ZONE=<GCP_ZONE_TO_USE>
```

3. Run the installation script.

```sh
bash install_hybrid_cluster.sh
```
```sh
# expected output
...
...
...
✅ Successfully set up SSH access from admin workstation to cluster node VMs.

🔄 Installing Anthos on bare metal...
Your active configuration is: [abm-test-project]
Pseudo-terminal will not be allocated because stdin is not a terminal.
Enter passphrase for key '/Users/sergrybrin/.ssh/google_compute_engine':
Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.15.0-1018-gcp x86_64)

* Documentation: https://help.ubuntu.com
* Management: https://landscape.canonical.com
* Support: https://ubuntu.com/advantage

System information as of Tue Oct 4 19:09:07 UTC 2022

System load: 0.39 Users logged in: 0
Usage of /: 1.3% of 193.65GB IPv4 address for docker0: 172.17.0.1
Memory usage: 1% IPv4 address for ens4: 10.128.0.2
Swap usage: 0% IPv4 address for vxlan0: 10.200.0.2
Processes: 153


0 updates can be applied immediately.

New release '22.04.1 LTS' available.
Run 'do-release-upgrade' to upgrade to it.


+ export PROJECT_ID=abm-test-project
+ PROJECT_ID=abm-test-project
+ export clusterid=cluster-1
+ clusterid=cluster-1
+ bmctl create config -c cluster-1
[2022-10-04 19:09:08+0000] Created config: bmctl-workspace/cluster-1/cluster-1.yaml
+ cat
+ bmctl create cluster -c cluster-1
Please check the logs at bmctl-workspace/cluster-1/log/create-cluster-20221004-190908/create-cluster.log
[2022-10-04 19:09:14+0000] Creating bootstrap cluster... OK
[2022-10-04 19:10:24+0000] Installing dependency components... OK
[2022-10-04 19:11:51+0000] Waiting for preflight check job to finish... OK
[2022-10-04 19:13:51+0000] - Validation Category: machines and network
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.5
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.6
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.7
[2022-10-04 19:13:51+0000] - [PASSED] gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.4-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.3-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.4
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.5-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.6-gcp
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.7-gcp
[2022-10-04 19:13:51+0000] - [PASSED] node-network
[2022-10-04 19:13:51+0000] - [PASSED] pod-cidr
[2022-10-04 19:13:51+0000] - [PASSED] 10.200.0.3
[2022-10-04 19:13:51+0000] Flushing logs... OK
[2022-10-04 19:13:53+0000] Applying resources for new cluster
[2022-10-04 19:13:53+0000] Waiting for cluster kubeconfig to become ready OK
[2022-10-04 19:17:03+0000] Writing kubeconfig file
[2022-10-04 19:17:03+0000] kubeconfig of cluster being created is present at bmctl-workspace/cluster-1/cluster-1-kubeconfig
[2022-10-04 19:17:03+0000] Please restrict access to this file as it contains authentication credentials of your cluster.
[2022-10-04 19:17:03+0000] Waiting for cluster to become ready OK
[2022-10-04 19:23:43+0000] Please run
[2022-10-04 19:23:43+0000] kubectl --kubeconfig bmctl-workspace/cluster-1/cluster-1-kubeconfig get nodes
[2022-10-04 19:23:43+0000] to get cluster nodes status.
[2022-10-04 19:23:43+0000] Waiting for node pools to become ready OK
[2022-10-04 19:24:03+0000] Waiting for metrics to become ready in GCP OK
[2022-10-04 19:24:13+0000] Moving admin cluster resources to the created admin cluster
[2022-10-04 19:24:20+0000] Waiting for node update jobs to finish OK
[2022-10-04 19:26:40+0000] Flushing logs... OK
[2022-10-04 19:26:40+0000] Deleting bootstrap cluster... OK
✅ Installation complete. Please check the logs for any errors!!!
```
Loading