Merge pull request #2 from stack-spot/fix/0410-2024

Improvments to actions and add gitlab workflow example

Author: eliezer-zup

action.yaml

@@ -0,0 +1,20 @@
+schema-version: v3
+kind: action
+metadata:
+  name: workflow-main-action
+  display-name: Workflows main action
+  description: Responsible to define which workflow will be executed based on type.
+  version: 1.0.0
+spec:
+  type: python
+  docs:
+    en-us: docs/en-us/docs.md
+  repository: https://github.com/stack-spot/workflow-stackspot-actions-runtime-selfhosted.git
+  inputs:
+    - label: Workflow type
+      name: workflow_type
+      type: text
+      required: true
+  python:
+    workdir: .
+    script: script.py

docs/en-us/docs.md

@@ -0,0 +1,57 @@
+image: ubuntu:latest
+
+# Define global variables
+variables:
+  ENVIRONMENT: "staging"
+  WORKFLOW_REPO_URL: "https://$GITHUB_PAT@github.com/stack-spot/workflow-stackspot-actions-runtime-selfhosted.git"
+
+stages:
+  - run_stackspot
+
+# Common setup steps for all jobs
+before_script:
+  # Install necessary dependencies
+  - apt-get -qq update
+  - apt-get install -y curl git
+
+  # Download and install STK CLI
+  - curl -s -O "https://stk.stackspot.com/installer/linux/stk"
+  - chmod +x stk
+  - ./stk init
+  
+  - export STK=~/.stk/bin/stk
+
+  # Verify STK CLI installation
+  - $STK --version
+
+stk:
+  stage: run_stackspot
+  script:
+    # Export environment variables for StackSpot
+    - export INPUTS_CLIENT_ID=$STK_CLIENT_ID
+    - export INPUTS_CLIENT_KEY=$STK_CLIENT_SECRET
+    - export INPUTS_CLIENT_REALM=$STK_REALM
+    - export INPUTS_TF_STATE_REGION=$AWS_REGION
+    - export INPUTS_IAC_REGION=$AWS_REGION
+    - export INPUTS_AWS_REGION=$AWS_REGION
+    - export INPUTS_IAC_BUCKET_NAME=$IAC_BUCKET_NAME
+    - export INPUTS_TF_STATE_BUCKET_NAME=$TF_STATE_BUCKET_NAME
+    - export INPUTS_AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID
+    - export INPUTS_AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY
+    - export INPUTS_AWS_SESSION_TOKEN=$AWS_SESSION_TOKEN
+    - export INPUTS_ENVIRONMENT=$ENVIRONMENT
+
+    # Authenticate with StackSpot
+    - $STK login --client-id $INPUTS_CLIENT_ID --client-key $INPUTS_CLIENT_KEY --realm $INPUTS_CLIENT_REALM
+
+    # Use the specified workspace
+    - $STK use workspace $STK_WORKSPACE
+
+    # Clone the workflow repository
+    - git clone $WORKFLOW_REPO_URL
+    - cd workflow-stackspot-actions-runtime-selfhosted
+    - run_action_path=$(pwd)
+    - cd ..
+
+    # Run the StackSpot action
+    - $STK run action $run_action_path --workflow_type deploy --version_tag $CI_JOB_ID --repository_name $CI_PROJECT_NAME --non-interactive

examples/gitlab/stackspot-deploy.yml

@@ -4,19 +4,18 @@ metadata:
   name: runtime-cancel-run-action
   display-name: runtime-cancel-run-action
   description: runtime-cancel-run-action
-  version: 0.0.1
+  version: 1.0.0
 spec:
   type: python
   docs:
-    pt-br: docs/pt-br/docs.md
     en-us: docs/en-us/docs.md
   repository: https://github.com/stack-spot/workflow-stackspot-actions-runtime-selfhosted.git
   inputs:
     - label: Run id
       name: run_id
       type: text
-      required: false
-      help: 'Inform execution Id'
+      pattern: "^[0-9A-HJ-NP-Z]{26}$"
+      required: true
   python:
     workdir: .
     script: script.py

runtime-cancel-run-action/.stkignore

@@ -1,54 +1,18 @@
-<!-- 
-******************************************
+## runtime-cancel-run-action
 
-- THIS IS AN EXAMPLE OF HOW TO FILL OUT YOUR DOCUMENTATION OF CONTENT.
+Cancel Running Process
 
-- FILL OUT THE TEMPLATE BELOW WITH YOUR INFORMATION SO OTHER PEOPLE CAN USE IT. THIS DOCUMENTATION WILL APPEAR ON THE SECTION OF THE STACKSPOT PORTAL.
-
-******************************************
--->
-## Action name
-
-<!-- Write concisely describing your Action. -->
+This action cancels a running process identified by a `RUN_ID` by sending a cancellation request to the StackSpot Runtime Manager API.
 
 ## Requirements
 
-<!-- 
-[This is a guideline; delete this content and write your information outside this markup. <!-- ]
-
-- Describe the requirements that the user needs to know before using the Action.
--->
+- The user must have access to the StackSpot Runtime Manager API.
+- The `run_id` of the process to be cancelled must be provided.
 
 ## Usage
 
-<!-- 
-[This is a guideline; delete this content and write your information outside this markup. <!-- ]
-
-Add the steps for the user to use your Action:
-
-- What are the inputs?
-- Which methods should we know?
-- What are the resources?
-- Add the Action dependencies, if necessary.
-
-Example: 
-On your application’s folder, run the **action-doc-template** action and follow the instructions:
-1. Execute the command:
-`
-stk run action /Users/Home/action-doc-template
-`
--->
-
-## Release Notes
-
-<!-- 
-[This is a guideline; delete this content and write your information outside this markup. <!-- ]
-
-This section is only necessary if you publish a new Action version. Add what was changed, fixed, and the new features. 
-
-Example:
-###  action-doc-template v1.0.0
-
-#### Features
-Added new templates
--->
+1. Input:
+   - `run_id`: The ULID of the process to be cancelled.
+   
+2. Example usage:
+   stk run action . --run_id 01J9EKHN5V2R75MGGT8KMEAGH1

runtime-cancel-run-action/action.yaml

@@ -1,37 +1,69 @@
+import os
 from oscli.core.http import post_with_authorization
 
+
+STK_RUNTIME_MANAGER_DOMAIN = os.getenv("STK_RUNTIME_MANAGER_DOMAIN", "https://runtime-manager.v1.stackspot.com")
+
+
 def run(metadata):
+    """
+    Cancels a running process identified by the provided RUN_ID.
 
-    RUN_ID = metadata.inputs.get('run_id')
+    This function sends a cancellation request to the StackSpot Runtime Manager API
+    to cancel a running process. The cancellation is forced by appending `?force=true`
+    to the request URL.
 
-    if RUN_ID == "":
-        print("- RUN_ID was not provided.")
-        print("  No need to cancel it.")
-        exit(0)
+    Parameters:
+    -----------
+    metadata : object
+        An object containing the inputs for the function. It must include a 'run_id' key
+        in the `inputs` dictionary, which holds the ULID of the run to be cancelled.
 
-    # Calling Cancel Action
-    print("Cancelling Run...")
+    Example:
+    --------
+    metadata = {
+        'inputs': {
+            'run_id': '01F8MECHZX3TBDSZ7XRADM79XE'
+        }
+    }
+    run(metadata)
 
-    print(f"Requesting Run {RUN_ID} to be cancelled")
+    The function will print the status of the cancellation request based on the response
+    from the API.
 
-    cancel_request = post_with_authorization(url=f"https://runtime-manager.v1.stackspot.com/v1/run/cancel/{RUN_ID}?force=true", 
-                                    headers={'Content-Type': 'application/json' },
-                                    body=None,
-                                    timeout=20)
-        
-    if cancel_request.status_code == 202:
-        print(f"- RUN {RUN_ID} cancelled successfully!")
+    API Response Status Codes:
+    --------------------------
+    - 202: The run was successfully cancelled.
+    - 404: The run was not found.
+    - 422: The run is not currently running, so it cannot be aborted.
+    - Other: Any other status code will be treated as an error, and the function will
+      print the error details and exit the program.
 
-    elif cancel_request.status_code == 404:
-        print(f"- RUN {RUN_ID} not found.")
+    """
+    
+    # Extract the RUN_ID from the metadata inputs
+    RUN_ID = metadata.inputs['run_id']
+    print(f"> Requesting Run {RUN_ID} to be cancelled")
+    
+    # Send a POST request to cancel the run
+    cancel_request = post_with_authorization(
+        url=f"{STK_RUNTIME_MANAGER_DOMAIN}/v1/run/cancel/{RUN_ID}?force=true", 
+        headers={'Content-Type': 'application/json'},
+        body=None,
+        timeout=20
+    )
 
+    # Handle the response based on the status code
+    if cancel_request.status_code == 202:
+        print(f"> Cancelled successfully!")
+    elif cancel_request.status_code == 404:
+        print(f"> Not found.")
     elif cancel_request.status_code == 422:
-        print(f"- RUN {RUN_ID} not currently running. Unable to Abort.")
-
+        print(f"> Not currently running. Unable to Abort.")
     else:
+        # Handle any other error response
         print("- Error cancelling run")
         print("- Status:", cancel_request.status_code)
         print("- Error:", cancel_request.reason)
         print("- Response:", cancel_request.text)
-        exit(1)
-
+        exit(1)

runtime-cancel-run-action/docs/en-us/docs.md

@@ -6,9 +6,8 @@ metadata:
   description: runtime-create-manifest-action
   version: 0.0.1
 spec:
-  type: shell
+  type: python
   docs:
-    pt-br: docs/pt-br/docs.md
     en-us: docs/en-us/docs.md
   repository: https://github.com/stack-spot/workflow-stackspot-actions-runtime-selfhosted.git
   inputs:
@@ -18,24 +17,12 @@ spec:
       required: true
       help: 'Inform environment used to deploy'
 
-    - label: Workspace used to deploy
-      name: workspace
-      type: text
-      required: true
-      help: 'Inform workspace used to deploy'
-
     - label: Deploy version tag
       name: version_tag
       type: text
       required: true
       help: 'Inform deploy version tag'
 
-    - label: Branch to perform checkout in Runtime
-      name: branch
-      type: text
-      required: false
-      help: 'Inform branch to perform checkout in Runtime'
-
     - label: Path to API file to publish on StackSpot Catalog API
       name: open_api_path
       type: text
@@ -48,32 +35,9 @@ spec:
       required: false
       help: '--key1 value1 --key2 value2'
 
-    - label: Verbose configuration
-      name: verbose
-      type: bool
-      required: false
-      default: true
-      help: 'verbose configuration'
-
-    - label: stk
-      name: stk
-      type: text
-      required: false
-      default: stk
-      help: 'stk'
-
-
-  shell:
+  python:
     workdir: .
+    script: script.py
 
-    script:
-      linux: |
-        chmod +x {{component_path}}/script.sh
-        sh {{component_path}}/script.sh
-      mac: |
-        chmod +x {{component_path}}/script.sh
-        sh {{component_path}}/script.sh
-      windows: |
-        echo "Not supported"