Merge pull request #9 from troy-bishop/main

Fix the scenario where a custom z/OS image needs to override the parmlib location

Author: anunezde

README.md

@@ -32,7 +32,7 @@ This set of scripts and automation can be used in conjunction with Wazi Image Bu
 
    This will create the VSI with the required data volumes. You might want to use the VSI serial console: the progress logs are written there by cloud init.
 
-Once compeleted successfully, the following can be observed as output:
+Once completed successfully, the following can be observed as output:
 
 - A bootable qcow2 image is uploaded to the IBM Cloud Object Storage bucket
 - A VPC block storage device, storing data volumes from the z/OS image, is created

data_mover/data_mover.py

@@ -33,6 +33,8 @@
 
 METADATA_FILE = 'image-metadata.json'
 DEVMAP_FILE = 'devmap'
+ENV_OVERRIDES_FILE = 'env-overrides'
+PROPERTIES_JSON_FILE = 'properties.json'
 VOLUME_DIRECTORIES = '/volumes/'
 BOOT_VOLUME_DIRECTORY = VOLUME_DIRECTORIES+'boot/' # Trailing slashes
 DATA_VOLUME_DIRECTORY = VOLUME_DIRECTORIES+'data/' # Trailing slashes
@@ -45,6 +47,30 @@
     endpoint_url=COS_ENDPOINT)
 
 
+def copy_env_overrides_file():
+    '''
+    Copy the env-overrides file, if it exists, to the data volume
+    '''
+    env_overrides_exists = exists_in_bucket(COS_BUCKET_NAME, ENV_OVERRIDES_FILE)
+    if env_overrides_exists:
+        env_overrides_filename = DATA_VOLUME_DIRECTORY + '../env-overrides'
+        with open(env_overrides_filename, 'wb') as file:
+            file.write(get_item(COS_BUCKET_NAME, ENV_OVERRIDES_FILE).read())
+        shutil.copy(env_overrides_filename, DATA_VOLUME_DIRECTORY)
+
+
+def copy_properties_file():
+    '''
+    Copy the properties.json file, if it exists, to the data volume
+    '''
+    properties_file_exists = exists_in_bucket(COS_BUCKET_NAME, PROPERTIES_JSON_FILE)
+    if properties_file_exists:
+        properties_filename = DATA_VOLUME_DIRECTORY + '../properties.json'
+        with open(properties_filename, 'wb') as file:
+            file.write(get_item(COS_BUCKET_NAME, PROPERTIES_JSON_FILE).read())
+        shutil.copy(properties_filename, DATA_VOLUME_DIRECTORY)
+
+
 def pull_metadata_file():
     '''
     Pulls the metadata file from a COS bucket, and returns it.
@@ -65,6 +91,23 @@ def pull_devmap():
     os.chown(volume + 'devmap', 999, 999)
 
 
+def exists_in_bucket(bucket_name, item_name):
+    '''
+    Validate that a given item name (file name) exists in the given bucket name.
+    '''
+    global bucket_contents
+    print('Checking if the item \'{1}\' exists in the bucket \'{0}\''.format(bucket_name, item_name))
+    try:
+        if item_name in get_bucket_contents(COS_BUCKET_NAME):
+            return True
+        else:
+            return False
+    except ClientError as ce:
+        exit('CLIENT ERROR: {0}\n'.format(ce))
+    except Exception as e:
+        exit('Unable to retrieve file contents: {0}'.format(e))
+
+
 def get_item(bucket_name, item_name):
     '''
     For a given bucket name and item name (file name), return the contents of that file, 
@@ -264,6 +307,10 @@ def format_and_mount(volume):
     # Define 5 concurrent processes to get the volume files with
     p = Pool(10)
 
+    # Copy the env-overrides and/or properties.json files, if they exists in the COS bucket
+    copy_env_overrides_file()
+    copy_properties_file()
+
     # Pull the metadata file from the COS bucket and get 
     # the boot volume and data volume names
     metadata_file = pull_metadata_file()

my-settings.auto.tfvars-template

@@ -3,6 +3,7 @@ ibmcloud_api_key = "Your IBM Cloud API key"
 cos_instance_name = "Cloud Object Storage-xx"
 cos_bucket_name = "wazi-custom-image-bucket"
 cos_bucket_region = "ca-tor"
+cos_resource_group = "Default"
 
 custom_image_name = "wazi-custom-image"