Get S3 bucket object name from user (#439)

* Add option to pass s3 bucket object

* Add option to pass s3 bucket object

* update zip_and_upload_to_s3

Author: rnetser

README.md

@@ -24,7 +24,7 @@ Action also can be passed to the CLI as `--action create/destroy` instead of spe
 * `--clusters-install-data-directory`: Clusters configurations are written to `<clusters-install-data-directory><platform><cluster name>`; write permissions are needed.
     * `<cluster directory>/auth` contains `kubeconfig` and `kubeadmin-password` files
 * `--parallel`: To create / destroy clusters in parallel
-* Pass `--s3-bucket-name` (and optionally `--s3-bucket-path`) to backup <cluster directory> in an S3 bucket.  
+* Pass `--s3-bucket-name` (and optionally `--s3-bucket-path` and `--s3-bucket-object-name`) to back up <cluster directory> in an S3 bucket.  
 * `--ocm-token`: OCM token, defaults to `OCM_TOKEN` environment variable.
 * `--must-gather-output-dir`: Path to must-gather output dir. `must-gather` will try to collect data when cluster installation fails and cluster can be accessed.
 
@@ -211,6 +211,7 @@ podman run quay.io/redhat_msi/openshift-cli-installer \
     --registry-config-file=registry-config.json \
     --s3-bucket-name=openshift-cli-installer \
     --s3-bucket-path=install-folders \
+    --s3-bucket-object-name=cluster-backup \
     --cluster 'name=ipi1;base-domain=gcp.interop.ccitredhat.com;platform=gcp;region=us-east1;version=4.14.0-ec.2;worker-flavor=custom-4-16384;log_level=info'
 ```
   * Default `log_level=error` is set for cluster config to hide the openshift-installer logs which contains kubeadmin password.
@@ -260,7 +261,8 @@ podman run quay.io/redhat_msi/openshift-cli-installer \
     --action create \
     --registry-config-file=registry-config.json \
     --s3-bucket-name=openshift-cli-installer \
-    --s3-bucket-path=install-folders \  --cluster 'name=hyper1;platform=hypershift;region=us-west-2;version=4.13.4;compute-machine-type=m5.4xlarge;replicas=6;channel-group=candidate;expiration-time=2h;timeout=1h' \
+    --s3-bucket-path=install-folders \
+    --cluster 'name=hyper1;platform=hypershift;region=us-west-2;version=4.13.4;compute-machine-type=m5.4xlarge;replicas=6;channel-group=candidate;expiration-time=2h;timeout=1h' \
     --ocm-token=$OCM_TOKEN \
 
     --cluster 'name=ipi1;base-domain=aws.interop.ccitredhat.com;platform=aws;region=us-east-2;version=4.14.0-ec.2;worker-flavor=m5.xlarge' \

openshift_cli_installer/cli.py

@@ -88,6 +88,11 @@
     help="S3 bucket path UUID to append to the S3 zip file name",
     show_default=True,
 )
+@click.option(
+    "--s3-bucket-object-name",
+    help="S3 bucket object name; Will be saved as a zip file",
+    show_default=True,
+)
 @click.option(
     "--ocm-token",
     help="OCM token.",

openshift_cli_installer/libs/clusters/ipi_cluster.py

@@ -170,8 +170,7 @@ def _rollback_on_error(_ex=None):
             zip_and_upload_to_s3(
                 install_dir=self.cluster_info["cluster-dir"],
                 s3_bucket_name=self.s3_bucket_name,
-                s3_bucket_path=self.s3_bucket_path,
-                uuid=self.cluster_info["shortuuid"],
+                s3_bucket_object_name=self.cluster_info["s3-object-name"],
             )
 
     def destroy_cluster(self):

openshift_cli_installer/libs/clusters/ocp_cluster.py

@@ -140,9 +140,9 @@ def get_ocm_client(self):
         ).client
 
     def _add_s3_bucket_data(self):
+        object_name = self.s3_bucket_object_name or f"{self.cluster_info['name']}-{self.cluster_info['shortuuid']}"
         self.cluster_info["s3-object-name"] = (
-            f"{f'{self.s3_bucket_path}/' if self.s3_bucket_path else ''}"
-            f"{self.cluster_info['name']}-{self.cluster_info['shortuuid']}.zip"
+            f"{f'{self.s3_bucket_path}/' if self.s3_bucket_path else ''}{object_name}.zip"
         )
 
     def check_and_assign_aws_cluster_region(self):

openshift_cli_installer/libs/clusters/osd_cluster.py

@@ -87,8 +87,7 @@ def create_cluster(self):
             zip_and_upload_to_s3(
                 install_dir=self.cluster_info["cluster-dir"],
                 s3_bucket_name=self.s3_bucket_name,
-                s3_bucket_path=self.s3_bucket_path,
-                uuid=self.cluster_info["shortuuid"],
+                s3_bucket_object_name=self.cluster_info["s3-object-name"],
             )
 
     def destroy_cluster(self):

openshift_cli_installer/libs/clusters/rosa_cluster.py

@@ -226,10 +226,9 @@ def create_cluster(self):
 
         if self.s3_bucket_name:
             zip_and_upload_to_s3(
-                uuid=self.cluster_info["shortuuid"],
                 install_dir=self.cluster_info["cluster-dir"],
                 s3_bucket_name=self.s3_bucket_name,
-                s3_bucket_path=self.s3_bucket_path,
+                s3_bucket_object_name=self.cluster_info["s3-object-name"],
             )
 
     def destroy_cluster(self):

openshift_cli_installer/libs/user_input.py

@@ -52,6 +52,7 @@ def __init__(self, **kwargs):
         self.s3_bucket_name = self.user_kwargs.get("s3_bucket_name")
         self.s3_bucket_path = self.user_kwargs.get("s3_bucket_path")
         self.s3_bucket_path_uuid = self.user_kwargs.get("s3_bucket_path_uuid")
+        self.s3_bucket_object_name = self.user_kwargs.get("s3_bucket_object_name")
         self.destroy_clusters_from_s3_bucket = self.user_kwargs.get("destroy_clusters_from_s3_bucket")
         self.destroy_clusters_from_s3_bucket_query = self.user_kwargs.get("destroy_clusters_from_s3_bucket_query")
         self.destroy_clusters_from_install_data_directory = self.user_kwargs.get(

openshift_cli_installer/scripts/openshift-cli-installer-build-command.py

@@ -35,6 +35,8 @@ def main():
         cmd += f" --s3-bucket-path={os_env['S3_BUCKET_PATH']}"
     if os_env.get("S3_BUCKET_PATH_UUID"):
         cmd += f" --s3-bucket-path-uuid={os_env['S3_BUCKET_PATH_UUID']}"
+    if os_env.get("S3_BUCKET_OBJECT_NAME"):
+        cmd += f" --s3-bucket-object-name={os_env['S3_BUCKET_OBJECT_NAME']}"
     if os_env.get("AWS_ACCESS_KEY_ID"):
         cmd += f" --aws-access-key-id={os_env['AWS_ACCESS_KEY_ID']}"
     if os_env.get("AWS_SECRET_ACCESS_KEY"):

openshift_cli_installer/utils/general.py

@@ -4,6 +4,7 @@
 import shutil
 from functools import wraps
 from importlib.util import find_spec
+from pathlib import Path
 from time import sleep
 
 import click
@@ -54,17 +55,13 @@ def inner(*args, **kwargs):
 
 
 @ignore_exceptions()
-def zip_and_upload_to_s3(install_dir, s3_bucket_name, uuid, s3_bucket_path=None):
+def zip_and_upload_to_s3(install_dir, s3_bucket_name, s3_bucket_object_name):
     remove_terraform_folder_from_install_dir(install_dir=install_dir)
 
-    _base_name = f"{install_dir}-{uuid}"
+    zip_file = shutil.make_archive(base_name=Path(s3_bucket_object_name).stem, format="zip", root_dir=install_dir)
 
-    zip_file = shutil.make_archive(base_name=_base_name, format="zip", root_dir=install_dir)
-    bucket_key = os.path.join(s3_bucket_path or "", os.path.split(zip_file)[-1])
-    LOGGER.info(f"Upload {zip_file} file to S3 {s3_bucket_name}, path {bucket_key}")
-    s3_client().upload_file(Filename=zip_file, Bucket=s3_bucket_name, Key=bucket_key)
-
-    return _base_name
+    LOGGER.info(f"Upload {zip_file} file to S3 {s3_bucket_name}, path {s3_bucket_object_name}")
+    s3_client().upload_file(Filename=zip_file, Bucket=s3_bucket_name, Key=s3_bucket_object_name)
 
 
 def get_manifests_path():