cortexapps-cli 0.24.2__tar.gz → 0.25.0__tar.gz

{cortexapps_cli-0.24.2 → cortexapps_cli-0.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cortexapps-cli
-Version: 0.24.2
+Version: 0.25.0
 Summary: Command Line Interface for cortexapps
 License: MIT
 Author: Cortex Apps
@@ -251,6 +251,125 @@ Your cortex config file will require api keys for both tenants.  It would look l
 are automatically imported by Cortex.  Cortex does not have access to any keys, so it cannot export any
 integration configurations.
 
+
+---------------------------------------------------------
+Export all services from one tenant; import into another
+---------------------------------------------------------
+
+This example shows how to export services from a tenant named :code:`myTenant-dev` and import those services into a tenant
+named :code:`myTenant`.  It is similar to the full export example "`Export from one tenant; import into another`_", but only
+exports/imports services.
+
+Your cortex config file will require api keys for both tenants.  It would look like this:
+
+.. code-block::
+
+ [myTenant]
+ api_key = <your API Key for myTenant>
+
+ [myTenant-dev]
+ api_key = <your API Key for myTenant-dev>
+
+
+**Option 1: export service YAMLs to a directory and then import them**
+
+This option is helpful in case you want to save the entity YAML files.  It makes it easy to restart or retry an import
+because you will have all YAMLs saved on disk.
+
+**Export**
+
+.. code:: bash
+
+ mkdir -p /tmp/cortex-export
+ cd /tmp/cortex-export
+ for service in `cortex -t myTenant catalog list -t service | jq -r ".entities[].tag" | sort`
+ do
+    cortex -t myTenant catalog descriptor -y -t ${service} > ${service}.yaml
+ done
+
+**Import**
+
+.. code:: bash
+
+ cd /tmp/cortex-export
+ for file in `ls -1 *.yaml`
+ do
+    cortex -t myTenant-dev catalog create -f ${file}
+ done
+
+**Option 2: combine the export and import in a single command**
+
+This option is simpler and doesn't require any disk operations.  However, if it fails for any reason you have to run the 
+entire export/import in its entirety.
+
+.. code:: bash
+
+ for service in `cortex -t myTenant catalog list -t service | jq -r ".entities[].tag" | sort`
+ do
+    echo "Processing service: ${service}"
+    cortex -t myTenant catalog descriptor -y -t ${service} | cortex -t myTenant-dev catalog create -f-
+ done
+
+---------------------------------------------------------
+Export all domains from one tenant; import into another
+---------------------------------------------------------
+
+This example shows how to export domains from a tenant named :code:`myTenant-dev` and import those domains into a tenant
+named :code:`myTenant`.  It is similar to the full export example "`Export from one tenant; import into another`_", but only
+exports/imports domains.
+
+Your cortex config file will require api keys for both tenants.  It would look like this:
+
+.. code-block::
+
+ [myTenant]
+ api_key = <your API Key for myTenant>
+
+ [myTenant-dev]
+ api_key = <your API Key for myTenant-dev>
+
+
+**Option 1: export domain YAMLs to a directory and then import them**
+
+This option is helpful in case you want to save the entity YAML files.  It makes it easy to restart or retry an import
+because you will have all YAMLs saved on disk.
+
+**Export**
+
+.. code:: bash
+
+ mkdir -p /tmp/cortex-export
+ cd /tmp/cortex-export
+ for domain in `cortex -t myTenant catalog list -t domain | jq -r ".entities[].tag" | sort`
+ do
+    echo "creating ${domain}.yaml"
+    cortex -t myTenant catalog descriptor -y -t ${domain} > ${domain}.yaml
+ done
+
+**Import**
+
+.. code:: bash
+
+ cd /tmp/cortex-export
+ for file in `ls -1 *.yaml`
+ do
+    cortex -t myTenant-dev catalog create -f ${file}
+ done
+
+**Option 2: combine the export and import in a single command**
+
+This option is simpler and doesn't require any disk operations.  However, if it fails for any reason you have to run the 
+entire export/import in its entirety.
+
+.. code:: bash
+
+ for domain in `cortex -t myTenant catalog list -t domain | jq -r ".entities[].tag" | sort`
+ do
+    echo "Processing domain: ${domain}"
+    cortex -t myTenant catalog descriptor -y -t ${domain} | cortex -t myTenant-dev catalog create -f-
+ done
+
+
 ------------------------
 Iterate over all domains
 ------------------------
@@ -480,6 +599,24 @@ Run this command for two different scorecards and diff the csv files to compare
 
   sdiff -s /tmp/scorecard1.csv /tmp/scorecard2.csv
 
+-----------------------------------------------------------------------------
+Backup all Workday teams
+-----------------------------------------------------------------------------
+
+This recipe is helpful if you change your Workday report and want to save your existing teams in case you want to restore them.
+
+For each team it will create two files:
+- a JSON file that contains the Workday data
+- a Cortex team YAML file that refers to the Workday team
+
+.. code:: bash
+
+    for team in `cortex teams list | jq -r '.teams[] | select (.type == "IDP") | select (.idpGroup.provider == "WORKDAY") | .teamTag'`
+    do
+        cortex teams get -t ${team} > ${team}.json
+        cortex catalog descriptor -y -t ${team} > ${team}.yaml
+    done
+
 -----------------------------------------------------------------------------
 Delete all Workday teams
 -----------------------------------------------------------------------------
@@ -490,7 +627,7 @@ This recipe is helpful if you want to remove all Workday teams and import from s
 
     for team in `cortex teams list | jq -r '.teams[] | select (.type == "IDP") | select (.idpGroup.provider == "WORKDAY") | .teamTag'`
     do
-        cortex team delete -t ${team}
+        cortex teams delete -t ${team}
     done
 
 ====================================

{cortexapps_cli-0.24.2 → cortexapps_cli-0.25.0}/README.rst

@@ -230,6 +230,125 @@ Your cortex config file will require api keys for both tenants.  It would look l
 are automatically imported by Cortex.  Cortex does not have access to any keys, so it cannot export any
 integration configurations.
 
+
+---------------------------------------------------------
+Export all services from one tenant; import into another
+---------------------------------------------------------
+
+This example shows how to export services from a tenant named :code:`myTenant-dev` and import those services into a tenant
+named :code:`myTenant`.  It is similar to the full export example "`Export from one tenant; import into another`_", but only
+exports/imports services.
+
+Your cortex config file will require api keys for both tenants.  It would look like this:
+
+.. code-block::
+
+ [myTenant]
+ api_key = <your API Key for myTenant>
+
+ [myTenant-dev]
+ api_key = <your API Key for myTenant-dev>
+
+
+**Option 1: export service YAMLs to a directory and then import them**
+
+This option is helpful in case you want to save the entity YAML files.  It makes it easy to restart or retry an import
+because you will have all YAMLs saved on disk.
+
+**Export**
+
+.. code:: bash
+
+ mkdir -p /tmp/cortex-export
+ cd /tmp/cortex-export
+ for service in `cortex -t myTenant catalog list -t service | jq -r ".entities[].tag" | sort`
+ do
+    cortex -t myTenant catalog descriptor -y -t ${service} > ${service}.yaml
+ done
+
+**Import**
+
+.. code:: bash
+
+ cd /tmp/cortex-export
+ for file in `ls -1 *.yaml`
+ do
+    cortex -t myTenant-dev catalog create -f ${file}
+ done
+
+**Option 2: combine the export and import in a single command**
+
+This option is simpler and doesn't require any disk operations.  However, if it fails for any reason you have to run the 
+entire export/import in its entirety.
+
+.. code:: bash
+
+ for service in `cortex -t myTenant catalog list -t service | jq -r ".entities[].tag" | sort`
+ do
+    echo "Processing service: ${service}"
+    cortex -t myTenant catalog descriptor -y -t ${service} | cortex -t myTenant-dev catalog create -f-
+ done
+
+---------------------------------------------------------
+Export all domains from one tenant; import into another
+---------------------------------------------------------
+
+This example shows how to export domains from a tenant named :code:`myTenant-dev` and import those domains into a tenant
+named :code:`myTenant`.  It is similar to the full export example "`Export from one tenant; import into another`_", but only
+exports/imports domains.
+
+Your cortex config file will require api keys for both tenants.  It would look like this:
+
+.. code-block::
+
+ [myTenant]
+ api_key = <your API Key for myTenant>
+
+ [myTenant-dev]
+ api_key = <your API Key for myTenant-dev>
+
+
+**Option 1: export domain YAMLs to a directory and then import them**
+
+This option is helpful in case you want to save the entity YAML files.  It makes it easy to restart or retry an import
+because you will have all YAMLs saved on disk.
+
+**Export**
+
+.. code:: bash
+
+ mkdir -p /tmp/cortex-export
+ cd /tmp/cortex-export
+ for domain in `cortex -t myTenant catalog list -t domain | jq -r ".entities[].tag" | sort`
+ do
+    echo "creating ${domain}.yaml"
+    cortex -t myTenant catalog descriptor -y -t ${domain} > ${domain}.yaml
+ done
+
+**Import**
+
+.. code:: bash
+
+ cd /tmp/cortex-export
+ for file in `ls -1 *.yaml`
+ do
+    cortex -t myTenant-dev catalog create -f ${file}
+ done
+
+**Option 2: combine the export and import in a single command**
+
+This option is simpler and doesn't require any disk operations.  However, if it fails for any reason you have to run the 
+entire export/import in its entirety.
+
+.. code:: bash
+
+ for domain in `cortex -t myTenant catalog list -t domain | jq -r ".entities[].tag" | sort`
+ do
+    echo "Processing domain: ${domain}"
+    cortex -t myTenant catalog descriptor -y -t ${domain} | cortex -t myTenant-dev catalog create -f-
+ done
+
+
 ------------------------
 Iterate over all domains
 ------------------------
@@ -459,6 +578,24 @@ Run this command for two different scorecards and diff the csv files to compare
 
   sdiff -s /tmp/scorecard1.csv /tmp/scorecard2.csv
 
+-----------------------------------------------------------------------------
+Backup all Workday teams
+-----------------------------------------------------------------------------
+
+This recipe is helpful if you change your Workday report and want to save your existing teams in case you want to restore them.
+
+For each team it will create two files:
+- a JSON file that contains the Workday data
+- a Cortex team YAML file that refers to the Workday team
+
+.. code:: bash
+
+    for team in `cortex teams list | jq -r '.teams[] | select (.type == "IDP") | select (.idpGroup.provider == "WORKDAY") | .teamTag'`
+    do
+        cortex teams get -t ${team} > ${team}.json
+        cortex catalog descriptor -y -t ${team} > ${team}.yaml
+    done
+
 -----------------------------------------------------------------------------
 Delete all Workday teams
 -----------------------------------------------------------------------------
@@ -469,7 +606,7 @@ This recipe is helpful if you want to remove all Workday teams and import from s
 
     for team in `cortex teams list | jq -r '.teams[] | select (.type == "IDP") | select (.idpGroup.provider == "WORKDAY") | .teamTag'`
     do
-        cortex team delete -t ${team}
+        cortex teams delete -t ${team}
     done
 
 ====================================

{cortexapps_cli-0.24.2 → cortexapps_cli-0.25.0}/cortexapps_cli/cortex.py

@@ -107,7 +107,8 @@ def check_config_file(config_file, replace_string):
 def get_config(config, args, argv, parser, replace_string):
     if os.environ.get('CORTEX_API_KEY'):
         if args.tenant:
-            print("WARNING: tenant setting overidden by CORTEX_API_KEY", file=sys.stderr)
+            if not args.quiet:
+                print("WARNING: tenant setting overidden by CORTEX_API_KEY", file=sys.stderr)
 
         cortex_base_url = os.environ.get('CORTEX_BASE_URL', default='https://api.getcortexapp.com')
         config.update({"url": cortex_base_url})
@@ -1010,13 +1011,13 @@ def subparser_catalog_list(subparser):
             'list',
             help='List all entities across the Service, Resource and Domain Catalogs.\n This API returns summary data for each entity, so refer to the retrieve entity method to lookup more details for a single entity.'
     )
-    add_argument_groups(sp)
     sp.add_argument(
-            '-o',
-            '--owners',
-            help='Filter based on owner group names, which correspond to the x-cortex-owners field in the Catalog Descriptor. Accepts a comma-delimited list of owner group names',
-            default=argparse.SUPPRESS,
-            metavar=''
+            '-a',
+            '--includeArchived',
+            help='Whether to include archived entities in the response, default to false',
+            default=False,
+            action='store_true',
+            required=False
     )
     sp.add_argument(
             '-d',
@@ -1025,13 +1026,7 @@ def subparser_catalog_list(subparser):
             default='full',
             metavar=''
     )
-    sp.add_argument(
-            '-r',
-            '--gitRepositories',
-            help='Supports only GitHub repositories in the org/repo format',
-            default=argparse.SUPPRESS,
-            metavar=''
-    )
+    add_argument_groups(sp)
     sp.add_argument(
             '-i',
             '--includeHierarchyFields',
@@ -1041,24 +1036,17 @@ def subparser_catalog_list(subparser):
             required=False
     )
     sp.add_argument(
-            '-t',
-            '--types',
-            help='Filter the response to specific types of entities. By default, this includes services, resources, and domains. Corresponds to the x-cortex-type field in the Entity Descriptor.',
+            '-in',
+            '--includeNestedFields',
+            help='List of sub fields to include for different types, for example team:members',
             default=argparse.SUPPRESS,
-            metavar=''
-    )
-    sp.add_argument(
-            '-a',
-            '--includeArchived',
-            help='Whether to include archived entities in the response, default to false',
-            default=False,
-            action='store_true',
+            metavar='',
             required=False
     )
     sp.add_argument(
-            '-m',
-            '--includeMetadata',
-            help='Whether to include custom data for each entity in the response',
+            '-io',
+            '--includeOwners',
+            help='Whether to include ownership information for each entity in the response',
             default=False,
             action='store_true',
             required=False
@@ -1072,21 +1060,36 @@ def subparser_catalog_list(subparser):
             required=False
     )
     sp.add_argument(
-            '-io',
-            '--includeOwners',
-            help='Whether to include ownership information for each entity in the response',
+            '-m',
+            '--includeMetadata',
+            help='Whether to include custom data for each entity in the response',
             default=False,
             action='store_true',
             required=False
     )
     sp.add_argument(
-            '-in',
-            '--includeNestedFields',
-            help='List of sub fields to include for different types, for example team:members',
+            '-o',
+            '--owners',
+            help='Filter based on owner group names, which correspond to the x-cortex-owners field in the Catalog Descriptor. Accepts a comma-delimited list of owner group names',
             default=argparse.SUPPRESS,
-            metavar='',
-            required=False
+            metavar=''
+    )
+    add_argument_page(sp)
+    sp.add_argument(
+            '-r',
+            '--gitRepositories',
+            help='Supports only GitHub repositories in the org/repo format',
+            default=argparse.SUPPRESS,
+            metavar=''
     )
+    sp.add_argument(
+            '-t',
+            '--types',
+            help='Filter the response to specific types of entities. By default, this includes services, resources, and domains. Corresponds to the x-cortex-type field in the Entity Descriptor.',
+            default=argparse.SUPPRESS,
+            metavar=''
+    )
+    add_argument_page_size(sp)
     sp.set_defaults(func=catalog_list)
 
 def catalog_list(args):
@@ -3167,7 +3170,7 @@ def subparser_ip_allowlist_validate(subparser):
                 }
                 '''))
     add_argument_file(sp, 'file containing JSON-formatted content of IP allowlist entries')
-    sp.set_defaults(func=ip_allowlist_get)
+    sp.set_defaults(func=ip_allowlist_validate)
 
 def ip_allowlist_validate(args):
     headers = default_headers()
@@ -3954,6 +3957,7 @@ def cli(argv=sys.argv[1:]):
     parser.add_argument('-c', '--config', help='Config location, default = ~/.cortex/config', default=os.path.expanduser('~') + '/.cortex/config')
     parser.add_argument('-d', '--debug', help='Writes request debug information as JSON to stderr', action='store_true')
     parser.add_argument('-n', '--noObfuscate', help='Do not obfuscate bearer token when debugging', action='store_true')
+    parser.add_argument('-q', '--quiet', help='Suppress warning messages when overriding tenant settings with environment variables', action='store_true')
     parser.add_argument('-t', '--tenant', default='default', help='tenant name defined in ~/.cortex/config, defaults to \'default\'',metavar='')
     parser.add_argument('-v', '--version', action='version', version=version())
     sp = parser.add_subparsers(help='sub-command help')

{cortexapps_cli-0.24.2 → cortexapps_cli-0.25.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "cortexapps-cli"
 # version will be incremented via command line as part of github actions build
-version = "0.24.2"
+version = "0.25.0"
 description = "Command Line Interface for cortexapps"
 license = "MIT"
 authors = [