cortexapps-cli 0.26.3__tar.gz → 0.26.4__tar.gz

{cortexapps_cli-0.26.3 → cortexapps_cli-0.26.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cortexapps-cli
-Version: 0.26.3
+Version: 0.26.4
 Summary: Command Line Interface for cortexapps
 License: MIT
 Author: Cortex Apps
@@ -12,7 +12,8 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: pyyaml (>=6.0.1,<7)
-Requires-Dist: requests (>=2.3.0,<3)
+Requires-Dist: requests (>=2.32.3,<3)
+Requires-Dist: urllib3 (>=2.2.2)
 Project-URL: Bug Tracker, https://github.com/cortexapps/cli/issues
 Project-URL: Changes,  https://github.com/cortexapps/cli/blob/main/HISTORY.md
 Project-URL: Documentation,  https://github.com/cortexapps/cli/blob/main/README.rst
@@ -100,7 +101,7 @@ If you have multiple Cortex instances, you can create a section for each, for ex
  api_key = REPLACE_WITH_YOUR_CORTEX_API_KEY
  base_url = https://app.cortex.mycompany.com
 
-**NOTE:** if not supplied, base_url defaults to :code:`https://app.getcortexapp.com`.
+**NOTE:** if not supplied, base_url defaults to :code:`https://api.getcortexapp.com`.
 
 The CLI will retrieve configuration data from the :code:`[default]` section unless you pass the :code:`-t/--tenant` flag.
 
@@ -120,7 +121,7 @@ Environment Variables
 The CLI supports the following environment variables.  If provided, the Cortex config file will not be read.
 
 - CORTEX_API_KEY
-- CORTEX_BASE_URL - this is optional if using Cortex cloud; defaults to `https://app.getcortexapp.com`
+- CORTEX_BASE_URL - this is optional if using Cortex cloud; defaults to `https://api.getcortexapp.com`
 
 Example:
 
@@ -638,6 +639,136 @@ This recipe is helpful if you want to remove all Workday teams and import from s
         cortex teams delete -t ${team}
     done
 
+-----------------------------------------------------------------------------
+Add provider for all group type owners where provider is not listed
+-----------------------------------------------------------------------------
+
+This recipe adds the value of variable named ``provider`` to any owner for which **type = GROUP** and the provider field is not listed.  This recipe can be used to address this issue from Cortex release notes:
+``Starting July 2nd (2024), any group type owners in the x-cortex-owners section of an entity descriptor will require a provider to be explicitly defined.``
+
+Adjust the value of ``provider`` accordingly.  It must be one of the providers listed in our `public docs <https://docs.cortex.io/docs/reference/basics/ownership>`_.
+
+This recipe does the following:
+
+- It runs the Cortex query as documented in the release notes to find all group type owners where the provider is not defined.  The ``cortex queries`` parameter ``-f-`` indicates that the query input comes from stdin, provided by the here document (the content provided between the two 'EOF' delimiters).
+- The recipe waits 10 minutes (denoted by parameter ``-x 600``) for the query to complete.
+- It loops over the results of the Cortex query, adding the provider listed in the ``provider`` variable for any group owner where the provider is not defined in the entity.
+- The contents of the entity descriptor are changed using yq and then passed as stdin to the cortex catalog subcommand to update the entity. 
+
+.. code:: bash
+
+    provider="GITHUB"
+    query_output="query.json"
+
+    cortex queries run -f- -w -x 600 > ${query_output} << EOF
+    jq(entity.descriptor(), "[.info.\"x-cortex-owners\" | .[] | select(.type | ascii_downcase == \"group\") | select(.provider == null)] | length") > 0
+    EOF
+
+    for entity in `cat ${query_output} | jq -r ".result[].tag"`
+    do
+       echo "entity = $entity"
+       cortex catalog descriptor -y -t ${entity} | yq "with(.info.x-cortex-owners[]; select(.type | downcase == \"group\") | select(.provider == null) | .provider = \"${provider}\" )" | cortex catalog create -f-
+    done
+
+-----------------------------------------------------------------------------
+Obfuscating a Cortex export
+-----------------------------------------------------------------------------
+
+This script will obfuscate a Cortex backup.  This can be helpful for on-premise customers who may need to provide data to Cortex to help identify performance or usability issues.
+
+.. code:: bash
+
+   # Works off an existing cortex CLI backup.
+   # - Create a backup with cortex CLI command: cortex backup export -z 10000
+   set -e
+   input=$1
+   output=$2
+
+   all_file=${output}/all.yaml
+   obfuscated_file=${output}/obfuscated.yaml
+
+   echo "Output directory: ${output}"
+   translate_file="${output}/translate.csv"
+
+   if [ ! -d ${output} ]; then
+      mkdir -p ${output}
+   fi
+
+   for yaml in `ls -1 ${input}/catalog/*`
+   do
+      entity=$(yq ${yaml} | yq ".info.x-cortex-tag")
+      new_entity=$(echo ${entity} | md5sum | cut -d' ' -f 1)
+      echo "${entity},${new_entity}" >> ${translate_file}
+      echo "Creating: $new_entity"
+      cat ${yaml} |\
+         yq ".info.\"x-cortex-tag\" = \"${new_entity}\" | \
+             .info.title=\"${new_entity}\" | \
+             del(.info.description) | \
+             del(.info.\"x-cortex-link\") | \
+             del(.info.\"x-cortex-links\") | \
+             del(.info.\"x-cortex-groups\") | \
+             del(.info.\"x-cortex-custom-metadata\") | \
+             del(.info.\"x-cortex-issues\") | \
+             del(.info.\"x-cortex-git\") | \
+             del(.info.\"x-cortex-slack\") | \
+             del(.info.\"x-cortex-oncall\") | \
+             with(.info; \
+                select(.\"x-cortex-team\".members != null) | .\"x-cortex-team\".members = {\"name\": \"Cortex User\", \"email\": \"user@example.com\"} \
+                 )" >> ${all_file}
+      echo "---" >> ${all_file}
+   done
+
+   # The longer strings are translated first preventing substrings from being replaced in a longer string
+   cat ${translate_file} | sort -r > ${translate_file}.tmp && echo "entity,new_entity" > ${translate_file} && cat ${translate_file}.tmp >> ${translate_file} && rm ${translate_file}.tmp
+
+   python3 - ${all_file} ${translate_file} ${obfuscated_file} << EOF
+   import csv
+   import re
+   import sys
+
+   yaml_file = sys.argv[1]
+   translate_file = sys.argv[2]
+   output = sys.argv[3]
+
+   with open(yaml_file, 'r') as f:
+        bytes = f.read() # read entire file as bytes
+        with open(translate_file, newline='') as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                entity = row['entity']
+                new_entity = row['new_entity']
+                print("entity = " + entity + ", new_entity = " + new_entity)
+                bytes = bytes.replace("tag: " + entity, "tag: " + new_entity)
+                bytes = bytes.replace("name: " + entity, "name: " + new_entity)
+
+   f = open(output, "w")
+   f.write(bytes)
+   f.close()
+   EOF
+
+   # change all email addresses
+   sed -i 's/email:.*/email: user@example.com/' ${obfuscated_file}
+
+   # change all slack channel names
+   sed -i 's/channel:.*/channel: my-slack-channel/' ${obfuscated_file}
+
+   # copy export directory to new directory, without catalog YAML
+   rsync -av --exclude='catalog' ${input}/ ${output}
+   mkdir -p ${output}/catalog
+
+   # now split single file into multiple that can be passed as parameter to cortex catalog create -f
+   cd ${output}/catalog
+   yq --no-doc -s '"file_" + $index' ${obfuscated_file}
+
+   # tar it up
+   tar_file=$(basename ${output}).tar
+   cd ${output}
+   rm ${all_file}
+   rm ${translate_file} 
+   tar -cvf ${tar_file} ./*
+
+   echo "Created: ${output}/${tar_file}"
+
 ====================================
 
 .. |PyPI download month| image:: https://img.shields.io/pypi/dm/cortexapps-cli.svg

{cortexapps_cli-0.26.3 → cortexapps_cli-0.26.4}/README.rst

@@ -79,7 +79,7 @@ If you have multiple Cortex instances, you can create a section for each, for ex
  api_key = REPLACE_WITH_YOUR_CORTEX_API_KEY
  base_url = https://app.cortex.mycompany.com
 
-**NOTE:** if not supplied, base_url defaults to :code:`https://app.getcortexapp.com`.
+**NOTE:** if not supplied, base_url defaults to :code:`https://api.getcortexapp.com`.
 
 The CLI will retrieve configuration data from the :code:`[default]` section unless you pass the :code:`-t/--tenant` flag.
 
@@ -99,7 +99,7 @@ Environment Variables
 The CLI supports the following environment variables.  If provided, the Cortex config file will not be read.
 
 - CORTEX_API_KEY
-- CORTEX_BASE_URL - this is optional if using Cortex cloud; defaults to `https://app.getcortexapp.com`
+- CORTEX_BASE_URL - this is optional if using Cortex cloud; defaults to `https://api.getcortexapp.com`
 
 Example:
 
@@ -617,6 +617,136 @@ This recipe is helpful if you want to remove all Workday teams and import from s
         cortex teams delete -t ${team}
     done
 
+-----------------------------------------------------------------------------
+Add provider for all group type owners where provider is not listed
+-----------------------------------------------------------------------------
+
+This recipe adds the value of variable named ``provider`` to any owner for which **type = GROUP** and the provider field is not listed.  This recipe can be used to address this issue from Cortex release notes:
+``Starting July 2nd (2024), any group type owners in the x-cortex-owners section of an entity descriptor will require a provider to be explicitly defined.``
+
+Adjust the value of ``provider`` accordingly.  It must be one of the providers listed in our `public docs <https://docs.cortex.io/docs/reference/basics/ownership>`_.
+
+This recipe does the following:
+
+- It runs the Cortex query as documented in the release notes to find all group type owners where the provider is not defined.  The ``cortex queries`` parameter ``-f-`` indicates that the query input comes from stdin, provided by the here document (the content provided between the two 'EOF' delimiters).
+- The recipe waits 10 minutes (denoted by parameter ``-x 600``) for the query to complete.
+- It loops over the results of the Cortex query, adding the provider listed in the ``provider`` variable for any group owner where the provider is not defined in the entity.
+- The contents of the entity descriptor are changed using yq and then passed as stdin to the cortex catalog subcommand to update the entity. 
+
+.. code:: bash
+
+    provider="GITHUB"
+    query_output="query.json"
+
+    cortex queries run -f- -w -x 600 > ${query_output} << EOF
+    jq(entity.descriptor(), "[.info.\"x-cortex-owners\" | .[] | select(.type | ascii_downcase == \"group\") | select(.provider == null)] | length") > 0
+    EOF
+
+    for entity in `cat ${query_output} | jq -r ".result[].tag"`
+    do
+       echo "entity = $entity"
+       cortex catalog descriptor -y -t ${entity} | yq "with(.info.x-cortex-owners[]; select(.type | downcase == \"group\") | select(.provider == null) | .provider = \"${provider}\" )" | cortex catalog create -f-
+    done
+
+-----------------------------------------------------------------------------
+Obfuscating a Cortex export
+-----------------------------------------------------------------------------
+
+This script will obfuscate a Cortex backup.  This can be helpful for on-premise customers who may need to provide data to Cortex to help identify performance or usability issues.
+
+.. code:: bash
+
+   # Works off an existing cortex CLI backup.
+   # - Create a backup with cortex CLI command: cortex backup export -z 10000
+   set -e
+   input=$1
+   output=$2
+
+   all_file=${output}/all.yaml
+   obfuscated_file=${output}/obfuscated.yaml
+
+   echo "Output directory: ${output}"
+   translate_file="${output}/translate.csv"
+
+   if [ ! -d ${output} ]; then
+      mkdir -p ${output}
+   fi
+
+   for yaml in `ls -1 ${input}/catalog/*`
+   do
+      entity=$(yq ${yaml} | yq ".info.x-cortex-tag")
+      new_entity=$(echo ${entity} | md5sum | cut -d' ' -f 1)
+      echo "${entity},${new_entity}" >> ${translate_file}
+      echo "Creating: $new_entity"
+      cat ${yaml} |\
+         yq ".info.\"x-cortex-tag\" = \"${new_entity}\" | \
+             .info.title=\"${new_entity}\" | \
+             del(.info.description) | \
+             del(.info.\"x-cortex-link\") | \
+             del(.info.\"x-cortex-links\") | \
+             del(.info.\"x-cortex-groups\") | \
+             del(.info.\"x-cortex-custom-metadata\") | \
+             del(.info.\"x-cortex-issues\") | \
+             del(.info.\"x-cortex-git\") | \
+             del(.info.\"x-cortex-slack\") | \
+             del(.info.\"x-cortex-oncall\") | \
+             with(.info; \
+                select(.\"x-cortex-team\".members != null) | .\"x-cortex-team\".members = {\"name\": \"Cortex User\", \"email\": \"user@example.com\"} \
+                 )" >> ${all_file}
+      echo "---" >> ${all_file}
+   done
+
+   # The longer strings are translated first preventing substrings from being replaced in a longer string
+   cat ${translate_file} | sort -r > ${translate_file}.tmp && echo "entity,new_entity" > ${translate_file} && cat ${translate_file}.tmp >> ${translate_file} && rm ${translate_file}.tmp
+
+   python3 - ${all_file} ${translate_file} ${obfuscated_file} << EOF
+   import csv
+   import re
+   import sys
+
+   yaml_file = sys.argv[1]
+   translate_file = sys.argv[2]
+   output = sys.argv[3]
+
+   with open(yaml_file, 'r') as f:
+        bytes = f.read() # read entire file as bytes
+        with open(translate_file, newline='') as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                entity = row['entity']
+                new_entity = row['new_entity']
+                print("entity = " + entity + ", new_entity = " + new_entity)
+                bytes = bytes.replace("tag: " + entity, "tag: " + new_entity)
+                bytes = bytes.replace("name: " + entity, "name: " + new_entity)
+
+   f = open(output, "w")
+   f.write(bytes)
+   f.close()
+   EOF
+
+   # change all email addresses
+   sed -i 's/email:.*/email: user@example.com/' ${obfuscated_file}
+
+   # change all slack channel names
+   sed -i 's/channel:.*/channel: my-slack-channel/' ${obfuscated_file}
+
+   # copy export directory to new directory, without catalog YAML
+   rsync -av --exclude='catalog' ${input}/ ${output}
+   mkdir -p ${output}/catalog
+
+   # now split single file into multiple that can be passed as parameter to cortex catalog create -f
+   cd ${output}/catalog
+   yq --no-doc -s '"file_" + $index' ${obfuscated_file}
+
+   # tar it up
+   tar_file=$(basename ${output}).tar
+   cd ${output}
+   rm ${all_file}
+   rm ${translate_file} 
+   tar -cvf ${tar_file} ./*
+
+   echo "Created: ${output}/${tar_file}"
+
 ====================================
 
 .. |PyPI download month| image:: https://img.shields.io/pypi/dm/cortexapps-cli.svg

{cortexapps_cli-0.26.3 → cortexapps_cli-0.26.4}/cortexapps_cli/cortex.py

@@ -26,7 +26,7 @@ def version():
     try:
         with open("pyproject.toml", "rb") as f:
             pyproject = tomllib.load(f)
-        version = pyproject["project"]["version"]
+        version = pyproject["tool"]["poetry"]["version"]
     except Exception as e:
         version = importlib.metadata.version('cortexapps_cli')
     return version

{cortexapps_cli-0.26.3 → cortexapps_cli-0.26.4}/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.26.3"
+version = "0.26.4"
 description = "Command Line Interface for cortexapps"
 license = "MIT"
 authors = [
@@ -17,20 +17,21 @@ classifiers = [
 
 [tool.poetry.dependencies]
 python = "^3.11"
-requests = ">= 2.3.0, < 3"
+requests = ">= 2.32.3, < 3"
 pyyaml = ">= 6.0.1, < 7"
+urllib3 = ">= 2.2.2"
 
 [tool.poetry.scripts]
 cortex = "cortexapps_cli.cortex:cli"
 
 [tool.poetry.group.test.dependencies]
-pytest = "^7.4.3"
-pytest-cov = "^4.1.0"
+pytest = "^8.2.2"
+pytest-cov = "^5.0.0"
 
 
 [tool.poetry.group.dev.dependencies]
-pytest-xdist = "^3.4.0"
-responses = "^0.24.1"
+pytest-xdist = "^3.6.1"
+responses = "^0.25.3"
 
 [build-system]
 requires = ["poetry-core"]
@@ -44,7 +45,7 @@ Homepage = "https://github.com/cortexapps/cli"
 
 [tool.pytest.ini_options]
 markers = [
-    "serial",
+    "serial"
 ]
 minversion = "7.4.3"
 addopts = "--cov=cortexapps_cli --cov-append --cov-report term-missing"