Simplify justfile; use updated Cortex CLI

Author: jeff-schnitter

Justfile

@@ -1,149 +1,48 @@
-cortex_cli      := 'cortex'
-
-help:
-   @just -l
-   @echo ""
-   @echo "Details"
-   @echo "The setup recipe requires the following environment variables to be set:"
-   @echo "- CORTEX_API_KEY  - must have edit entity permission at a minimum, typically will be an admin key"
-   @echo "- CORTEX_BASE_URL - API endpoint, defaults to https://api.getcortexapp.com"
-   @echo "- CORTEX_EMAIL    - the user's cortex email address; will be used to assign as owner of the Learn Cortex entity"
-   @echo ""
-   @echo "The workflows recipe requires the following environment variables to be set:"
-   @echo "- GH_PAT  - a GitHub personal token that allows read/write access to github.com/cortexapps"
+cortex_cli := 'cortex'
+
+export CORTEX_API_KEY := env('CORTEX_API_KEY')
+export CORTEX_BASE_URL := env('CORTEX_BASE_URL', "https://api.getcortexapp.com")
+export CORTEX_EMAIL := env('CORTEX_EMAIL')
+export GH_PAT := env('GH_PAT')
+
+brew := require("brew")
+cortex := require("cortex")
+jq := require("jq")
+yq := require("yq")
+
+@help:
+   just -l
+   echo ""
+   echo "Details"
+   echo "The setup recipe requires the following environment variables to be set:"
+   echo "- CORTEX_API_KEY  - must have edit entity permission at a minimum, typically will be an admin key"
+   echo "- CORTEX_BASE_URL - API endpoint, defaults to https://api.getcortexapp.com"
+   echo "- CORTEX_EMAIL    - the user's cortex email address; will be used to assign as owner of the Learn Cortex entity"
+   echo "- GH_PAT          - a GitHub personal token that allows read/write access to github.com/cortexapps"
 
 # Add test entities and Scorecard to Cortex instance
-setup: _check load-data _success
-
-_check-vars:
-   #!/bin/bash
-
-   echo "Checking environment variables"
-
-   if [[ -z "${CORTEX_API_KEY}" ]]; then
-      echo ""
-      echo "ERROR: CORTEX_API_KEY environment variable is not set."
-      echo "------------------------------------------------------"
-      echo "Please set environment variable CORTEX_API_KEY and retry."
-      echo "Refer to https://docs.cortex.io/docs/walkthroughs/workspace-settings/personal-tokens for details on creating a personal token"
-      echo "Example: export CORTEX_API_KEY=<your personal token>"
-      echo ""
-      exit 1
-   fi
-
-   if [[ -z "${CORTEX_EMAIL}" ]]; then
-      echo ""
-      echo "ERROR: CORTEX_EMAIL environment variable is not set."
-      echo "----------------------------------------------------"
-      echo "Please set environment variable CORTEX_EMAIL and retry."
-      echo "It will be used as the owner of the Learn Cortex entity"
-      echo "Example: export [email protected]"
-      echo ""
-      exit 1
-   fi
-
-   CORTEX_BASE_URL=${CORTEX_BASE_URL:-https://api.getcortexapp.com}
-
-_check-pat:
-   #!/bin/bash
-
-   echo "Checking if GitHub PAT environment variable is set"
-
-   if [[ -z "${GH_PAT}" ]]; then
-      echo ""
-      echo "ERROR: GH_PAT environment variable is not set."
-      echo "------------------------------------------------------"
-      echo "This setup script will create a GitHub Personal token integration in Cortex."
-      echo "It requires a GitHub Personal Access Token to be set as an environment variable."
-      echo "Refer to https://docs.cortex.io/docs/reference/integrations/github#how-to-configure-github-with-cortex"
-      echo "for details on creating the token."
-      echo ""
-      echo "Once set, copy the content of the token and use it to set an environment variable as follows:"
-      echo "export GH_PAT=yourTokenValue"
-      echo ""
-      exit 1
-   fi
-
-
-_check: _check-brew _check-jq _check-yq _check-vars _check-cortex _mkdirs
-
-_check-brew:
-   @echo "Checking if brew is installed"
-   @which brew > /dev/null || /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-
-_check-jq:
-   @echo "Checking if jq is installed"
-   @which jq > /dev/null || brew install jq
-
-_check-yq:
-   @echo "Checking if yq is installed"
-   @which yq > /dev/null || brew install yq
-
-_check-cortex:
-   #!/bin/bash
-   echo "Checking if cortex CLI can access tenant"
-   {{cortex_cli}} audit-logs get -p 0 -z 1 > /dev/null 2>&1
-   if [[ $? -ne 0 ]]; then
-      echo "ERROR: Unable to access tenant with Cortex CLI."
-      echo "-----------------------------------------------"
-      echo "Check API key in ~/.cortex/config under the [default] section."
-      echo "To debug: run {{cortex_cli}} audit-logs get -o 0 -z 1"
-      exit 1
-   fi
-
-_mkdirs:
-   #!/bin/bash
-   if [[ ! -d data/teams ]]; then
-      mkdir data/teams
-   fi
-   if [[ ! -d data/resource-definitions ]]; then
-      mkdir data/resource-definitions
-   fi
+setup: load-data _success
 
 _success:
    @echo "SUCCESS!"
    @echo "Login to your tenant and navigate to your Learn Cortex entity to starting learning Cortex."
 
 # Install a single Cortex Scorecard file
-scorecard file: _check
+scorecard file:
    {{cortex_cli}} scorecard create -f {{file}}
 
 # Load data from 'data' directory into Cortex
-load-data: _check
+load-data: _github
    @echo "Adding data to tenant"
-   @{{cortex_cli}} backup import -d data > /dev/null 2>&1
+   {{cortex_cli}} backup import -d data
 
-   @cat data/catalog/learn-cortex.yaml | yq -e ".info.x-cortex-owners = [{ \"name\": \"${CORTEX_EMAIL}\", \"type\": \"EMAIL\" }]" | cortex catalog create -f- > /dev/null 2>&1
+   @cat data/catalog/learn-cortex.yaml | yq -e ".info.x-cortex-owners = [{ \"email\": \"${CORTEX_EMAIL}\", \"type\": \"EMAIL\" }]" | cortex catalog create -f- > /dev/null 2>&1
 
-
-# Add workflows for the Learn Cortex entity
-workflows: _check _github
-   #!/bin/bash
-   for workflow in $(ls -1 data/workflows)
-   do
-      status_code=$(\
-            curl \
-            -s \
-            -w "%{http_code}" \
-            -X POST \
-            --data-binary @data/workflows/${workflow} \
-            -H "Authorization: Bearer ${CORTEX_API_KEY}" \
-            -H "Content-Type: application/yaml" \
-            -o /dev/null \
-            "${CORTEX_BASE_URL}/api/v1/workflows")
-      if [ $status_code -ne 200 ]; then
-        echo "curl failed with HTTP code $status_code"
-        exit 1
-      else
-        echo "Added workflow: ${workflow}"
-      fi
-   done
-
 # Add secrets needed for the Learn Cortex entity
-_github: _check-pat
+_github:
    #!/bin/bash
 
-   cortex integrations github get-personal -a "cortex - prod" > /dev/null 2>&1
+   cortex integrations github list | jq -r ".configurations[].alias" | grep -e "cortex-prod\$" > /dev/null
    if [[ $? -ne 0 ]]; then
-      envsubst < data/integrations/github/pat-configuration-json.tmpl | cortex integrations github add-personal -f-
+      cortex integrations github add-personal -a "cortex-prod" --access-token ${GH_PAT}
    fi

data/integrations/github/pat-configuration-json.tmpl

@@ -14,56 +14,24 @@ evaluation:
 ladder:
   name: Default Ladder
   levels:
-  - name: Incomplete
-    rank: 1
-    color: "#FF9E9E"
-  - name: Completed
-    rank: 2
-    color: "#7CCB92"
+    - name: Incomplete
+      rank: 1
+      color: "#FF9E9E"
+    - name: Completed
+      rank: 2
+      color: "#7CCB92"
 rules:
-- title: Learned
-  expression: dependencies.out().any((dependency) => dependency.type == "AWS::S3::Bucket")
-  identifier: a335adc6-3bac-381e-9147-e8403fb8c4df
-  weight: 1
-  level: Completed
-  failureMessage: "# About\nThis scorecard rule will walk you through learning AWS\
-    \ for Cortex.\n\n# Setup\n- Sign up for a [free tier AWS account](https://portal.aws.amazon.com/billing/signup?p=ft&c=hp&z=6&refid=78b916d7-7c94-4cab-98d9-0ce5e648dd5f).\n\
-    \n- You will be prompted for a credit card.  We recommend using a virtual credit\
-    \ card service like privacy.com.  Create a virtual credit card with a $1 total\
-    \ spend limit.  Amazon indicates they may put a temporary $1 hold on your account\
-    \ to prove who you are.\n\n- Follow the Cortex [documentation](https://docs.cortex.io/docs/reference/integrations/aws)\
-    \ for configuring the AWS integration.\n\n- Make sure you have enabled [automatic\
-    \ import of AWS entities](https://docs.cortex.io/docs/reference/integrations/aws#enable-automatic-import-of-aws-entities).\
-    \  Not required if you complete end up manually importing entities (details below),\
-    \ but will be helpful for ongoing updates in your workspace.\n\n## Create an S3\
-    \ bucket via the AWS console\n- Login to the AWS console.  This should be a URL\
-    \ of the form https://<account id>.signin.aws.amazon.com/console.\n\n- Search\
-    \ for S3 in the search.\n\n- Click on S3 to go to the Simple Storage Service (S3)\
-    \ page.\n\n- Click on the \"Create Bucket\" button.\n\n- Give the bucket a unique\
-    \ name.  The bucket name needs to be unique, so recommend a format like <firstName>-<lastName>-learn-cortex-bucket.\n\
-    \n- Click on the add tag button.\n\n- Set key = service, value = learn-cortex.\n\
-    \n- Optional: click on the add tag button again.\n\n- Set key = owner, value =\
-    \ <x-cortex-tag for any team entity in your workspace>.\n\n# Task\n\n- AWS entities\
-    \ are synced daily in Cortex, but you can force a manual sync.\n    - Catalogs\
-    \ -> All Entities -> Import Entities -> Import Discovered Entities -> AWS -> Sync\
-    \ Entities.\n    - Click on your S3 bucket.\n    - Confirm Import\n- You should\
-    \ end up with an AWS::S3::Bucket entity resembling the following entity YAML:\n\
-    \    \n```\nopenapi: 3.0.1\ninfo:\n  title: jeff-schnitter-learn-cortex\n  x-cortex-tag:\
-    \ jeff-schnitter-learn-cortex\n  x-cortex-type: AWS::S3::Bucket\n  x-cortex-infra:\n\
-    \    aws:\n      cloudControl:\n      - type: AWS::S3::Bucket\n        region:\
-    \ us-east-1\n        accountId: \"331409392944\"\n        identifier: jeff-schnitter-learn-cortex\n\
-    ```\n\n- Outgoing dependencies are synced separately.\n- Navigate to the [relationship\
-    \ graph](https://app.getcortexapp.com/admin/graph) -> 3 dots -> Sync dependencies.\n\
-    - Navigate to the Learn Cortex entity\n- You should see an outgoing dependencies\
-    \ for the Learn Cortex entity that references your S3 bucket.\n\n![Learn Cortex\
-    \ entity](https://p-a6fkm3vd.t3.n0.cdn.zight.com/items/v1uzNDw6/57432f96-6ea8-40e0-a066-9c4d27086b94.jpg?source=viewer&v=cb5f1793e6e9308cbd5ac04233a3477c)\n\
-    \n# CQL Rule\nThe CQL rule for this rule verifies that the \"Learn Cortex\" has\
-    \ an outgoing dependency of type \"AWS::S3::Bucket\"."
+  - title: Learned
+    expression: dependencies.out().any((dependency) => dependency.type == "AWS::S3::Bucket")
+    identifier: a335adc6-3bac-381e-9147-e8403fb8c4df
+    weight: 1
+    level: Completed
+    failureMessage: "# About\nThis scorecard rule will walk you through learning AWS for Cortex.\n\n# Setup\n- Sign up for a [free tier AWS account](https://portal.aws.amazon.com/billing/signup?p=ft&c=hp&z=6&refid=78b916d7-7c94-4cab-98d9-0ce5e648dd5f).\n\n- You will be prompted for a credit card.  We recommend using a virtual credit card service like privacy.com.  Create a virtual credit card with a $1 total spend limit.  Amazon indicates they may put a temporary $1 hold on your account to prove who you are.\n\n- Follow the Cortex [documentation](https://docs.cortex.io/docs/reference/integrations/aws) for configuring the AWS integration.\n\n- Make sure you have enabled [automatic import of AWS entities](https://docs.cortex.io/docs/reference/integrations/aws#enable-automatic-import-of-aws-entities).  Not required if you complete end up manually importing entities (details below), but will be helpful for ongoing updates in your workspace.\n\n## Create an S3 bucket via the AWS console\n- Login to the AWS console.  This should be a URL of the form https://<account id>.signin.aws.amazon.com/console.\n\n- Search for S3 in the search.\n\n- Click on S3 to go to the Simple Storage Service (S3) page.\n\n- Click on the \"Create Bucket\" button.\n\n- Give the bucket a unique name.  The bucket name needs to be unique, so recommend a format like <firstName>-<lastName>-learn-cortex-bucket.\n\n- Click on the add tag button.\n\n- Set key = service, value = learn-cortex.\n\n- Optional: click on the add tag button again.\n\n- Set key = owner, value = <x-cortex-tag for any team entity in your workspace>.\n\n# Task\n\n- AWS entities are synced daily in Cortex, but you can force a manual sync.\n    - Catalogs -> All Entities -> Import Entities -> Import Discovered Entities -> AWS -> Sync Entities.\n    - Click on your S3 bucket.\n    - Confirm Import\n- You should end up with an AWS::S3::Bucket entity resembling the following entity YAML:\n    \n```\nopenapi: 3.0.1\ninfo:\n  title: jeff-schnitter-learn-cortex\n  x-cortex-tag: jeff-schnitter-learn-cortex\n  x-cortex-type: AWS::S3::Bucket\n  x-cortex-infra:\n    aws:\n      cloudControl:\n      - type: AWS::S3::Bucket\n        region: us-east-1\n        accountId: \"331409392944\"\n        identifier: jeff-schnitter-learn-cortex\n```\n\n- Outgoing dependencies are synced separately.\n- Navigate to the [relationship graph](https://app.getcortexapp.com/admin/graph) -> 3 dots -> Sync dependencies.\n- Navigate to the Learn Cortex entity\n- You should see an outgoing dependencies for the Learn Cortex entity that references your S3 bucket.\n\n![Learn Cortex entity](https://p-a6fkm3vd.t3.n0.cdn.zight.com/items/v1uzNDw6/57432f96-6ea8-40e0-a066-9c4d27086b94.jpg?source=viewer&v=cb5f1793e6e9308cbd5ac04233a3477c)\n\n# CQL Rule\nThe CQL rule for this rule verifies that the \"Learn Cortex\" has an outgoing dependency of type \"AWS::S3::Bucket\"."
 filter:
   kind: GENERIC
   types:
     include:
-    - service
+      - service
   groups:
     include:
-    - learn-cortex
+      - learn-cortex

data/scorecards/learn-aws.yaml

@@ -14,37 +14,40 @@ evaluation:
 ladder:
   name: Default Ladder
   levels:
-  - name: Unwritten
-    rank: 1
-    color: "#D7AC58"
-  - name: Completed
-    rank: 2
-    color: "#7CCB92"
+    - name: Unwritten
+      rank: 1
+      color: "#D7AC58"
+    - name: Completed
+      rank: 2
+      color: "#7CCB92"
 rules:
-- title: Learned
-  expression: custom("learned") != null
-  identifier: 921bc595-5a12-3aa1-af45-e17d17e0d649
-  weight: 1
-  level: Completed
-  failureMessage: |
-    # About
-    Describe what the scorecard does.
+  - title: Learned
+    expression: custom("learned") != null
+    identifier: 921bc595-5a12-3aa1-af45-e17d17e0d649
+    weight: 1
+    level: Completed
+    failureMessage: |
+      # About
+      Describe what the scorecard does.
 
-    # Set up
-    Refer to any existing documentation at https://cortex.io/docs and describe any third party software setup.
+      # Set up
+      Refer to any existing documentation at https://cortex.io/docs and describe any third party software setup.
 
 
-    # Related Cortex Academy courses
-    List any related courses available at academy.cortex.io.
+      # Related Cortex Academy courses
+      List any related courses available at academy.cortex.io.
 
-    # Task
-    Describe the steps to complete the task here.
+      # Task
+      Describe the steps to complete the task here.
 
 
-    # CQL Rule
-    Explain what the CQL checks.
+      # CQL Rule
+      Explain what the CQL checks.
 filter:
   kind: GENERIC
+  types:
+    include:
+      - service
   groups:
     include:
-    - learn-cortex
+      - learn-cortex

data/scorecards/learn-azure-devops.yaml

@@ -14,37 +14,40 @@ evaluation:
 ladder:
   name: Default Ladder
   levels:
-  - name: Unwritten
-    rank: 1
-    color: "#D7AC58"
-  - name: Completed
-    rank: 2
-    color: "#7CCB92"
+    - name: Unwritten
+      rank: 1
+      color: "#D7AC58"
+    - name: Completed
+      rank: 2
+      color: "#7CCB92"
 rules:
-- title: Learned
-  expression: custom("learned") != null
-  identifier: 921bc595-5a12-3aa1-af45-e17d17e0d649
-  weight: 1
-  level: Completed
-  failureMessage: |
-    # About
-    Describe what the scorecard does.
+  - title: Learned
+    expression: custom("learned") != null
+    identifier: 921bc595-5a12-3aa1-af45-e17d17e0d649
+    weight: 1
+    level: Completed
+    failureMessage: |
+      # About
+      Describe what the scorecard does.
 
-    # Set up
-    Refer to any existing documentation at https://cortex.io/docs and describe any third party software setup.
+      # Set up
+      Refer to any existing documentation at https://cortex.io/docs and describe any third party software setup.
 
 
-    # Related Cortex Academy courses
-    List any related courses available at academy.cortex.io.
+      # Related Cortex Academy courses
+      List any related courses available at academy.cortex.io.
 
-    # Task
-    Describe the steps to complete the task here.
+      # Task
+      Describe the steps to complete the task here.
 
 
-    # CQL Rule
-    Explain what the CQL checks.
+      # CQL Rule
+      Explain what the CQL checks.
 filter:
   kind: GENERIC
+  types:
+    include:
+      - service
   groups:
     include:
-    - learn-cortex
+      - learn-cortex