OpsMx
OpsMx
OpsMx
  • Home
  • Overview
    • OpsMx Intelligent Software Delivery (ISD) Platform - Spinnaker
      • Overview
      • Orchestration Module - OpsMx Enterprise for Spinnaker (OES)
        • OES Features
          • Automated Workflows
          • Multi-cloud Deployments
          • Safe-Deployment strategies
          • Scalable & Extensible
        • OES Concepts
          • Application Management
          • Application Deployment
      • Data and Intelligence Module - Autopilot
        • Overview
        • Observability
        • Audit and Traceability
        • Continuous Compliance - Policy
          • Policy - Overview
  • Operator Manual
    • Installation and Configuration
      • Quick Installation
        • ISD v4.0
        • ISD v4.0.1
        • ISD v4.0.2
        • ISD v4.0.3
        • ISD v4.0.4
      • Standard Installation
        • ISD v4.0
          • GitOps Based Installation
        • ISD v4.0.1
          • GitOps Based Installation
        • ISD v4.0.2
          • GitOps Based Installation
        • ISD v4.0.3
          • GitOps Based Installation
        • ISD v4.0.4
          • GitOps Based Installation
        • ISD v4.0.4.1
          • GitOps Based Installation
          • Instructions to Update the Parameters in value.yaml
        • ISD v4.0.4.2
          • GitOps Based Installation
          • Enabling Pipeline Insights and Stage Insights in ISD
        • ISD v4.0.4.3
          • GitOps Based Installation
          • Enabling Pipeline Insights and Stage Insights in ISD
          • Instructions to Update the Parameters in value.yaml
        • ISD v2024.06.00
          • GitOps Based Installation
        • ISD v2024.12.00
          • GitOps Based Installation
        • ISD v2025.03.00
          • Enabling Pipeline Insights or Deployment Insights or Stage Insights in ISD
          • GitOps Based Installation
      • Environment setup for OpsMx ISD
      • ISD On-Prem POV Infrastructure requirements
      • ISD On-Prem Production Infrastructure requirements
      • Stormdriver Installation
    • Access Management
      • User Role
      • Feature Visibility
    • SlackOps Interactive Notification
  • User Guide
    • Dashboard
      • Application Dashboard
      • Application Service View
    • Manage Application
      • Create an Application
      • Configure an Application
      • Delete an Application
    • Manage Pipelines
      • Create a Pipeline
      • Add Stage
      • Add Trigger
      • Edit Pipeline
      • Run Pipeline
      • Rename Pipeline
      • Delete Pipeline
      • Disable Pipeline
      • Lock Pipeline
      • View and Restore Pipeline
      • Pipeline level RBAC
      • Add Intelligent Gates to the Pipeline
        • Approval Gate
        • Verification Gate
        • Test Verification Gate
        • Policy Gate
      • Execute pipelines (Run deployments)
        • Rolling Restart for EKS manifest
        • Deployment to Kubernetes namespace with Manifest file
        • Deployment to Kubernetes namespace with Git based Manifest
        • Manual Approval before deployment
        • Blue/Green deployment using Manifest
        • Helm based deployment to Kubernetes namespace
    • Approvals
    • Policy Evaluation
    • Verification History
    • Infrastructure
      • Cluster
    • Integrations
      • Available Integrations
        • Artifact
        • CI
        • Governance
        • Monitoring Tools
        • Notifications
        • Policy
        • SAST/DAST
        • Pub/Sub Subscription Name
        • Verification
      • Used Integrations
        • Artifact
        • SAST / DAST
        • Monitoring Tools
    • Pipeline Templates
    • Cloud Targets
      • Create a new Cloud Target account
      • Cloud Target account operations
    • Environment Mapping
    • Custom Stages
      • ServiceNow
      • Pipeline Promotion
      • JIRA
      • Update PR
      • Custom notification
      • ServiceDesk
      • Ansible
      • Terraform
      • Ansible AWX
    • OpsMx Agent
      • Agent Overview
      • Agent Creation
      • Agent Service Configuration
      • Agent Installation
      • Delete an Agent
      • Agent and Controller Version Compatibility
    • Verification
    • CD Integration
    • Informed Approval
      • Overview
      • Artifactory
      • Bitbucket
      • Bitbucket Server
      • GITHUB
      • Bamboo
      • Jenkins
      • JIRA
      • ServiceNow
      • Aquawave
      • HCL AppScan
      • JFrog Xray
      • Prisma Cloud
      • SonarQube
      • Verification
    • Manage Policy
      • Create Policy
      • Edit Policy
      • Delete Policy
    • Continuous Verification
      • Overview
      • Templates
        • Log Template
        • Metric Template
      • Log Analysis
        • Events and Clusters
        • Cardinality consideration of Error Events
        • Interpreting the cluster graph
        • Interpreting the score
        • Perceived Risk and Sensitivity
        • Canary Threshold Calibration
        • Info-Cluster Scoring
      • Metric Analysis
      • Test Verification
      • Scoring Algorithms
        • Canary Scoring
        • Autonomous Scoring
        • Definite Scoring
        • Comprehensive Scoring
      • Enable integration into CI/CD pipelines
        • Integrate with CI/CD
        • Integrate with Jenkins
      • Continuous Verification Report Details
    • Unified logs report to track issues
    • Observability Plugin
    • Audit
      • Pipeline Execution
      • Pipeline Audit
      • Policy Audit
      • User Audit
    • Insights
      • Delivery Insights
      • Usage Insights
      • Pipeline Insights
      • User Insights
      • Stage Insights
      • Deployment Insights
  • Release Notes
    • OpsMx Enterprise for Spinnaker
      • OES Release Notes for Spinnaker Version v1.33.3
      • OES Release Notes for Spinnaker Version v1.30.1
    • ISD 4.0.x Release Notes
    • OES 3.9.X Release Notes
    • OES 3.8.X Release Notes
    • OES 3.7.X Release Notes
    • OES 3.6.X Release Notes
    • OES 3.5.X Release Notes
    • OES 3.4.X Release Notes
    • OES 3.3.X Release Notes
    • OES 3.2.X Release Notes
    • OES 3.1.X Release Notes
    • OES 3.0.X Release Notes
  • Additional Resources
    • Configuration Changes for 2025.03.00
      • Configuration changes for Opentelemetry with ISD
      • Configuration changes for Kafka Addition
      • Configuration changes for Secure Redis
      • Configuration changes to Disable Auto Pilot
      • Configuration changes for Custom Environment Mapping from Pipeline Name
    • Configuration Changes to Enable / Disable Insights Pages
    • Multi Spinnaker
    • API Reference
    • OpsMx Argo Sandbox Guide
    • Code Labs
      • Red Hat Certified Spinnaker Operator
      • How to Integrate Vault with Spinnaker
      • How to Create Terraform Custom Job in Spinnaker
      • How to Create Terraform Webhook Stage in Spinnaker
      • How to Create Ansible Custom Job in Spinnaker
      • How to set up Mutual TLS (mTLS) Authentication for Spinnaker Services
      • SSH
      • X.509
    • FAQs
    • Glossary
    • Previous releases
      • ISD 3.12
        • OpsMx Intelligent Software Delivery Platform
          • Overview
          • ISD Architecture
            • ISD Deployment Architecture
          • ISD Installation
            • ISD Installation Configuration
            • Helm Chart based installation
            • ISD Installation on OpenShift
            • ISD Installation Guide
            • Routing Web URLs to ISD services
            • ISD On-Prem POV Infrastructure requirements
            • ISD - Commonly used Commands
            • ISD Service Catalogue
            • Environment setup for OpsMx ISD
          • Life Cycle Management
          • OpsMx ISD Setup
            • Applications
              • Add Applications
              • Services and Pipelines
                • Overview
                • Add services and pipelines
                • Multiple services
              • Group Permissions
              • Edit Applications
              • Delete Application
            • Integrations
              • Available Integrations
            • Spinnaker Setup
            • Cloud Providers
              • Add new cloud provider account
              • Cloud provider account operations
            • OpsMx Agent
              • Agent Overview
              • Agent Installation
              • Agent Service Configuration
              • Agent Service Credentials
              • Agent Service Type
              • Delete an Agent
        • Orchestration Module - OpsMx Enterprise for Spinnaker (OES)
          • OES Features
            • Automated Workflows
            • Multi-cloud Deployments
            • Safe-Deployment strategies
            • Scalable & Extensible
          • OES Concepts
            • Application Management
            • Application Deployment
          • Feature Configuration
            • Application Management
              • Create an Application
              • Configure an Application
              • Delete an Application
            • Pipeline Management
              • Create a Pipeline
              • Add a Stage
              • Add a Trigger
              • Run a Pipeline
              • Pipeline with Parameter
              • Disable a Pipeline
              • Delete a pipeline
              • Edit a Pipeline
              • View and Restore Pipeline
              • Lock a Pipeline
              • Rename a Pipeline
            • Add Trigger Support
            • Configure Artifact Support
              • Google Cloud Storage
              • GitHub
              • GitHub Artifacts Spinnaker
              • GitLab
              • HTTP
            • Configure the Image Bakery
              • Overview
              • Google Compute Engine
            • Secure Spinnaker
              • Secure Spinnaker Installation
              • Authentication
                • Overview
                • SSL
                • Methods
                  • OAuth 2.0
                  • SAML
                  • LDAP
              • Authorization
                • Overview
                • User Role Providers
                  • Google Group
                  • GitHub Teams
                  • LDAP
                  • SAML
                • Service Account
            • Add CI System
              • Overview and Compatible List of CI Systems by Spinnaker
              • Steps to Configure CI Systems
                • Google Cloud Build
                • Jenkins
                • Travis CI
                • Wercker
            • Enable Monitoring
              • Steps to Setup Supported Monitoring Tools
                • Promethues and Grafana
                • Promethues and Kubernetes
            • List of Custom Stages
              • ServiceNow
              • Pipeline Promotion
              • JIRA
              • Update PR
              • Custom notification
              • ServiceDesk
              • Ansible
              • Terraform
            • SlackOps Interactive Notification
            • How to Setup Replication for Minio Storage Service on Openshift
        • Data and Intelligence Module - Autopilot
          • Overview
          • Installing Autopilot
          • Observability
            • Overview
            • Application Dashboard
            • Application Service View
          • Audit and Traceability
            • Overview
            • Application Audit
              • Pipeline Execution
              • Pipeline
              • Policy Audit
          • Insights
            • Delivery Insights
            • Usage Insights
          • Informed Approval
            • Overview
            • Artifactory
            • Bitbucket
            • Bitbucket Server
            • GITHUB
            • Bamboo
            • Jenkins
            • JIRA
            • ServiceNow
            • Aqua Wave
            • HCL AppScan
            • JFrog Xray
            • Prisma Cloud
            • SonarQube
            • Autopilot
          • Continuous Security
            • Audit Trail
            • Access Management
          • Continuous Compliance - Policy
            • Policy Management - Overview
            • Static Policies
            • Runtime Policies
          • Continuous Verification
            • Overview
            • Analysis Setup
              • Templates
                • Log Template
                • Metric Template
            • Log Analysis
              • Events & Clusters
              • Cardinality consideration of Error Events
              • Interpreting the cluster graph
              • Interpreting the score
              • Perceived Risk and Sensitivity
              • Canary Threshold Calibration
              • Contextual Clustering
              • Info-Cluster Scoring
            • Metric Analysis
            • AppDynamics Verification
              • Using AppDynamics Provider for verification
            • Test Verification
              • Analyze Test runs
            • Scoring Algorithms
              • Canary Scoring
              • Autonomous Scoring
              • Definite Scoring
              • Comprehensive Scoring
            • Enable integration into CI/CD pipelines
              • Integrate with CI/CD
              • Integrate with Jenkins
            • Report Details
            • Supervised Learning
        • Quickstart Guide
          • Contents
          • Quick ISD Installation
            • ISD/Spinnaker (OES) 3.12 Quick Installation
            • Helm based Installation
          • Setup & Configure ISD product
            • ISD Installation Configuration
            • Routing Web URLs to ISD services
            • ISD On-Prem POV Infrastructure requirements
          • Manage Applications
            • Create an Application
            • Configure an Application
            • Delete an Application
          • Manage Pipelines
            • Create a Pipeline
            • Edit a Pipeline
            • Add Intelligent Gates to the Pipeline
              • Add Approval Gate
              • Add Verification Gate
              • Add Test Verification Gate
              • Add Policy Gate
            • Run deployments (Execute pipelines)
              • Deployment to Kubernetes namespace with Manifest file
              • Deployment to Kubernetes namespace with Git based Manifest
              • Manual Approval before deployment
              • Blue/Green deployment using Manifest
              • Helm based deployment to Kubernetes namespace
          • Configure Integrations
            • Add Integrations
            • Edit and Delete Integrations
          • Manage Deployment Accounts
            • Add Deployment Accounts
            • Edit Deployment Accounts
            • Delete Deployment Accounts
          • Manage Policy
            • Create Policy
            • Edit Policy
            • Delete Policy
          • Configure & Setup Spinnaker with ISD
          • Agent Configuration
            • Add a New Agent
            • Configure an Agent
            • Delete an Agent
        • Trial User Guide
          • User Guide
          • SaaS Trial Usage: Instruction Video
          • Copy of Trial User Guide
        • Codelabs
          • Red Hat Certified Spinnaker Operator
          • How to Integrate Vault with Spinnaker
          • How to Create Terraform Custom Job in Spinnaker
          • How to Create Terraform Webhook Stage in Spinnaker
          • How to Create Ansible Custom Job in Spinnaker
          • How to set up Mutual TLS (mTLS) Authentication for Spinnaker Services
          • SSH
          • X.509
        • API Reference
        • FAQs
        • Glossary
        • Release Notes
          • ISD 3.12.x Release Notes
          • ISD 3.11.x Release Notes
          • ISD 3.10.x Release Notes
          • OES 3.9.X Release Notes
          • OES 3.8.X Release Notes
          • OES 3.7.X Release Notes
          • OES 3.6.X Release Notes
          • OES 3.5.X Release Notes
          • OES 3.4.X Release Notes
          • OES 3.3.X Release Notes
          • OES 3.2.X Release Notes
          • OES 3.1.X Release Notes
          • OES 3.0.X Release Notes
        • Upgrade
          • Upgrade from 3.11.x to 3.12.x
          • Upgrade from 3.11.x to 3.11.2
          • Upgrade from 3.11.x to 3.11.1
          • Upgrade from 3.10.x to 3.11
          • Upgrade from 3.9.x to 3.10
          • Upgrade from 3.9.x to 3.9.5
          • Upgrading to OES 3.7
      • ISD 3.10
        • OpsMx Intelligent Software Delivery Platform
          • Overview
          • ISD Architecture
            • ISD Deployment Architecture
          • ISD Installation
            • ISD Installation Configuration
            • Helm Chart based installation - Detailed
            • ISD Installation on OpenShift
          • Life Cycle Management
          • OpsMx ISD Setup
            • Applications
              • Add Applications
              • Services and Pipelines
                • Overview
                • Add services and pipelines
                • Multiple services
              • Group Permissions
              • Edit Applications
              • Delete Application
            • Integrations
              • Available Integrations
            • Spinnaker Setup
            • Cloud Providers
              • Add new cloud provider account
              • Cloud provider account operations
            • OpsMx Agent
              • Agent Overview
              • Agent Installation
              • Agent Service Configuration
              • Agent Service Credentials
              • Agent Service Type
              • Deleting an Agent
        • Orchestration Module - OpsMx Enterprise for Spinnaker (OES)
          • Overview
            • Automated Workflows
            • Multi-cloud Deployments
            • Safe-Deployment strategies
            • Scalable & Extensible
          • Additional Feature Configuration
            • Configure Artifact Support
              • Overview
              • Google Cloud Storage
              • GitHub
              • GitHub Artifacts Spinnaker
              • GitLab
              • HTTP
            • Configure the Image Bakery
              • Overview
              • Google Compute Engine
            • Secure Spinnaker
              • Secure Spinnaker Installation
              • Authentication
                • Overview
                • SSL
                • Methods
                  • OAuth 2.0
                  • SAML
                  • LDAP
                  • X.509
              • Authorization
                • Overview
                • User Role Providers
                  • Google Group
                  • GitHub Teams
                  • LDAP
                  • SAML
                • Service Account
            • Setup Triggers
              • Google Cloud Pub/Sub
              • GitHub WebHook
            • Add CI System
              • Overview and Compatible List of CI Systems by Spinnaker
              • Steps to Configure CI Systems
                • Google Cloud Build
                • Jenkins
                • Travis CI
                • Wercker
            • Enable Monitoring
              • Overview
              • Steps to Setup Supported Monitoring Tools
                • Datadog
                • Promethues and Grafana
                • Promethues and Kubernetes
                • Stackdriver
            • Steps to Setup Canary Support
            • Additional Features Setup
              • Productionize Spinnaker
                • Overview
                • Configure Caching
                  • Configure Scaling
                    • Steps to Scale Orca
                    • Steps to Scale Clouddriver
                  • Configure Persistence
                    • Steps to Setup Set up Orca to use SQL
                  • Steps to Externalize Redis
                  • Steps to Configure Spinnaker’s Usage for Redis
              • Configure Notifications
                • Email
                • HipChat
                • Slack
                • SMS via Twilio
              • Configure User Data(Metadata)
            • Configure Script Stage
            • How to Setup Replication for Minio Storage Service on Openshift
        • Data and Intelligence Module - Autopilot
          • Overview
          • Installing Autopilot
          • Observability
            • Overview
            • Application Dashboard
            • Application Service View
          • Audit and Traceability
            • Overview
            • Application Audit
              • Pipeline Execution
              • Pipeline Changes
            • Policy Audit
          • Insights
            • Overview
            • Delivery Insights
            • Usage Insights
          • Informed Approval
            • Overview
            • JIRA
            • GIT
            • JENKINS
            • AUTOPILOT
            • SONARQUBE
          • Continuous Security
            • Overview
            • Security
            • Access Management
          • Continuous Compliance - Policy
            • Policy Management - Overview
            • Static Policies
            • Runtime Policies
          • Continuous Verification
            • Overview
            • Analysis Setup
              • Templates
                • Log Template
                • Metric Template
            • Log Analysis
              • Events & Clusters
              • Cardinality consideration of Error Events
              • Interpreting the cluster graph
              • Interpreting the score
              • Perceived Risk and Sensitivity
              • Canary Threshold Calibration
              • Contextual Clustering
              • Info-Cluster Scoring
            • Metric Analysis
            • Test Verification
              • Analyze Test runs
            • Scoring Algorithms
              • Canary Scoring
              • Definite Scoring
              • Comprehensive Scoring
              • Autonomous Scoring
            • Enable integration into CI/CD pipelines
              • Integrate with CI/CD
              • Integrate with Jenkins
              • Integrate with Spinnaker (ACA and Canary)
            • Report Details
            • Supervised Learning
      • Spinnaker
        • Spinnaker Concepts
        • Spinnaker Architecture
        • Spinnaker Installation
        • Spinnaker Application
        • Spinnaker Pipeline
        • Cloud & Storage Providers
        • Continuous Integration Providers
        • Trigger Support
        • Authentication and Authorization
        • Caching Agents
        • Configure Caching Agents
        • Configure Slack notifications
        • Integrate Jira with Spinnaker
        • Continuous Deployment to Kubernetes using GitHub triggered Spinnaker pipelines
        • Configure GitHub OAuth
        • Add CI System
          • Overview and Compatible List of CI Systems by Spinnaker
          • Steps to Configure CI Systems
            • Google Cloud Build
            • Jenkins
            • Travis CI
            • Wercker
    • Spinnaker Reference
      • Spinnaker Concepts
      • Spinnaker Architecture
      • Spinnaker Installation
        • Halyard Installation
        • Configure cloud provider
        • Choose your Environment
          • Local Git installation
        • Configure Storage Service
        • Deploy Spinnaker
      • Spinnaker Application
      • Spinnaker Pipeline
      • Cloud & Storage Providers
      • Continuous Integration Providers
      • Trigger Support
      • Authentication and Authorization
      • Caching Agents
      • Configure Caching Agents
      • Configure Slack notifications
      • Integrate Jira with Spinnaker
      • Continuous Deployment to Kubernetes using GitHub triggered Spinnaker pipelines
      • Configure GitHub OAuth
    • Troubleshooting
      • Troubleshooting ISD GitOps Installation Issues
    • Rollback Instructions
      • Revert the GitHub Commit
    • Database
      • Periodic Backup and Recovery of ISD DB
      • Periodic Cleanup of Historic Data in ISD Database
    • Upgrade
      • Upgrade to 2025.03.00
      • Upgrade to 2024.12.00
      • Upgrade to 2024.06.00
      • Upgrade 4.0.3.1 to 4.0.4.3
      • Upgrade from 4.0.4.1 to 4.0.4.2
      • Upgrade from 4.0.4 to 4.0.4.1
      • Upgrade from 4.0.3 to 4.0.4
      • Upgrade from 4.0.3 to 4.0.3.1
      • Upgrade from 4.0.2 to 4.0.3
      • Upgrade from 3.12.x to 4.0.3
        • Changes from 3.12 to 4.0.3 branch
      • Upgrade from 4.0.1 to 4.0.2
      • Upgrade from 3.12.x to 4.0.2
      • Upgrade from 3.12.x to 4.0
      • Upgrade from 3.11.x to 3.12.x
      • Upgrade from 3.11 to 3.11.x
      • Upgrade from 3.10.x to 3.11
      • Upgrade from 3.9.x to 3.10
      • Upgrade from 3.9.x to 3.9.5
      • Upgrading to OES 3.7
  • OpsMx Intelligent Software Delivery (ISD) Platform - Argo
    • Overview
    • Intelligent Software Delivery (ISD) for Argo
    • OpsMx Enterprise for Argo(OEA)
    • Getting Started
      • Platform Installation
      • Getting started with Automated Analysis
      • Automated Analysis User Guide
      • Trial Sandbox User Guide
    • Operator Manual
      • ISD-Argo Standard Installation
        • ISD-Argo Installation with Argo CD and Argo Rollouts
        • ISD-Argo Platform Standard Installation
        • Additional Argo Installation
      • Access Management
      • Configure Authentication Providers through ISD UI
      • Slack Interactive Notification
    • User Guide
      • Application Dashboard
      • Manage Application
        • Create Application
        • Edit Application
        • Sync Application
        • Deploy Application
        • Sync Application Status
        • History and Rollback
        • Refresh Application
        • Delete Application
      • Delivery Verification
        • OpsMx Provider Configmap
        • Templates
          • Create Log Template in ISD UI
          • Create Metric Template in ISD UI
          • Create Log Template in Git
          • Create Metric Template in Git
        • Analysis Template
        • Deployments
        • Analysis History
        • Log Analysis
        • Metric Analysis
        • Interval Analysis
        • Scoring Algorithms
          • Canary Scoring
          • Autonomous Scoring
          • Definite Scoring
          • Comprehensive Scoring
        • Argo Rollouts analysis with ISD and NewRelic
        • Argo Rollouts analysis with ISD and Prometheus
        • Argo Rollouts analysis with ISD and Stackdriver
        • Argo Rollouts analysis with ISD and Elasticsearch
        • Deployments
      • Integrations
        • Available Integrations
      • Notification
      • Argo CD Integration
        • Argo CD Integration with ISD
        • Mapping of host URL with agent-grpc service
      • Insights
      • Audit
        • Deployments Audit
        • System Audit
      • Opsmx Agent
        • Agent Overview
        • Agent Creation
        • Agent Configuration and Installation
        • Edit and Delete Agent
    • Release Notes
      • ISD 4.1 - Release Notes (ISD for Argo)
    • Additional Resources
      • Troubleshooting
        • Troubleshooting ISD Argo Installation Issues
        • Troubleshooting connectivity issues between Argo CD and ISD
      • Upgrade
        • Upgrade ISD-Argo with Argo CD and Argo Rollouts from v4.1.2 to v4.1.3
        • Upgrade ISD-Argo Platform from v4.1.2 to v4.1.3
        • Upgrade ISD-Argo with Argo CD and Argo Rollouts from v4.1.1 to v4.1.2
        • Upgrade ISD-Argo Platform from v4.1.1 to v4.1.2
        • Upgrade Additional Argo from v4.1.1 to v4.1.2
      • Configuration Changes
        • Configuration Changes for 2025.01.00
        • Configuration Changes for 2024.08.00
          • Configuration for System Audit
          • Configuration for Notification
        • Configuration Changes for 4.1.9
        • Configuration Changes for 4.1.8
        • Steps to Generate Token for Agent/Controller v5.x
        • SAML 2 Configuration
        • Controller and Agent Changes for 4.1.7
      • Configuring Application Synchronization (Refresh) Duration
      • Environment setup for ISD-Argo
      • Create API token in Argo CD
      • Create new account for Argo CD with API key and RBAC permissions
      • ISD agent-grpc external IP
      • Previous releases
        • Install Instructions: ISD-Argo v4.1.2
          • ISD-Argo Installation with Argo CD and Argo Rollouts
          • ISD-Argo Platform Standard Installation
          • Additional Argo Installation
        • ISD-Argo v4.1.1
          • Overview
          • Intelligent Software Delivery (ISD) for Argo
          • OpsMx Enterprise for Argo(OEA)
          • Getting Started
            • ISD-Argo Quick Installation
          • Operator Manual
            • Installation and Configuration
              • Installation via curl command
                • ISD-Argo Full Installation via curl command
                • Autopilot Installation via curl command
                • Worker OEA Installation via curl command
              • ISD-Argo Standard Installation
                • ISD-Argo Full Installation
                • ISD-Argo Rollouts Installation
                • Autopilot Installation
                • Worker OEA Installation
              • ISD-Argo On-Prem POV Infrastructure Requirements
              • ISD-Argo On-Prem Production Infrastructure Requirements
              • Environment setup for ISD-Argo
              • Mapping of host URL with agent-grpc service
            • Access Management
            • Slack Interactive Notification
          • User Guide
            • Application Dashboard
            • Manage Application
              • Create Application
              • Edit Application
              • Sync Application
              • Deploy Application
              • Sync Application Status
              • History and Rollback
              • Refresh Application
              • Delete Application
            • Delivery Verification
              • OpsMx Provider Configmap
              • Templates
                • Create Log Template in ISD UI
                • Create Metric Template in ISD UI
                • Create Log Template in Git
                • Create Metric Template in Git
              • Analysis Template
              • Analysis History
              • Log Analysis
              • Metric Analysis
              • Interval Analysis
              • Scoring Algorithms
                • Canary Scoring
                • Autonomous Scoring
                • Definite Scoring
                • Comprehensive Scoring
            • Integrations
              • Available Integrations
            • CD Integration
            • Insights
            • Deployments Audit
            • Opsmx Agent
              • Agent Overview
              • Agent Creation
              • Agent Configuration and Installation
              • Edit and Delete Agent
      • Best Practices for setting up Verification
      • Worker OEA Installation
  • OpsMx Delivery Shield Platform
    • Delivery Shield Overview
    • Getting Started
      • Delivery Shield Feature Overview
      • Installing Delivery Shield
      • Integration with Kubernetes Cluster
        • Integrating Kube Detector
        • Enable Deployment Firewall in Target Clusters
      • Integrating Registry in Delivery Shield
        • ACR
        • ECR
        • GCR
      • Integrating CI and CD tools in Delivery Shield
        • GitHub
        • GitLab
        • Bitbucket
        • Jenkins
        • ArgoCD
        • Spinnaker
        • Quay
        • Docker
        • Google Artifact Registry
        • JFrog Artifactory
        • Sysdig
      • Integrating Security Scanning tools in Delivery Shield
        • Grype
        • VirusTotal
        • Kubescape
        • Snyk
        • Trivy
        • Semgrep
        • Codacy
        • Sonarqube
        • ZAP
        • JFrog Xray
      • Integrating Cloud Service Providers in Delivery Shield
        • AWS
        • ScouteSuite
      • Integrating Other tools in Delivery Shield
        • ChatGPT
        • Slack
        • JIRA
        • MobSF
        • TFsec
        • Custom Policy Source
      • Support Matrix
    • User Guide
      • View Security Posture
        • Organization Security Posture
        • Application Security Posture
          • View Version History
          • Context Graph
        • View Open Security Issues
        • View Current Deployments
        • View Deployment History
      • Manage Policies
        • Global Policies
        • Application Policies
      • Vulnerability Management
      • License Scan
      • Artifact Security
        • Deployed Artifacts
        • Generated Artifacts
        • Plugin Artifacts
        • Mobile Artifacts
      • Global Risk Management
        • OSS Risk
        • Cloud Security
          • Compute
          • Network
          • Security
      • Adhoc Scan
      • Managing Audit
        • Exceptions
      • Deployment Firewall
      • Delivery Bill of Materials (DBOM)
      • Software Bill of Materials (SBOM)
      • Compare Environments using Smart Diff
      • Manage Teams and Access
      • Managing Clusters
      • Compliance Automation
        • NIST 800-53
        • FedRAMP
        • OpenSSF ScoreCard
        • OWASP Top 10 CI CD Security Risks
        • NSA CISA Top 10
        • MITRE-ATT&CK
        • CIS Benchmark Kubernetes
      • AI Powered Features
        • Rules Genie
        • Security Issues Genie
    • Release Notes
    • Additional Resources
      • Whitelisting API Calls for Self-Hosted Delivery Shield
Powered by GitBook
On this page
  • Configure and use Terraform Custom Job Stage
  • Configuration Steps:
  • Executing Terraform Scripts via the custom job stage

Was this helpful?

  1. Additional Resources
  2. Code Labs

How to Create Terraform Custom Job in Spinnaker

PreviousHow to Integrate Vault with SpinnakerNextHow to Create Terraform Webhook Stage in Spinnaker

Last updated 2 years ago

Was this helpful?

Configure and use Terraform Custom Job Stage

What you’ll learn:

  1. How to configure and set up Terraform stage in Spinnaker as a custom stage job.

  2. How to execute Terraform operations through.

Prerequisites:

  1. Understanding of spinnaker and spinnaker custom job.

  2. Running spinnaker with Kubernetes cluster account configured in it.

    • Get detailed information about

    • At OpsMx we have developed open-source TerraSpin micro-service which seamlessly integrates with spinnaker through spinnaker custom job. Which ideally creates three stages in spinnaker ( TSPlanJob, TSApplyJob, and TSDestroyJob ). Each stage has its own input fields and output.

Configuration Steps:

Execute the below steps to configure Spinnaker with TerraSpin Custom Job.

  1. Create a file ‘artifactaccounts.json’ add the below content and replace values according to your artifact account. The artifactaccounts.json contains account details from where the job pulls terraform code. The details are:

    • accountname : This can be any descriptive name without spaces.

    • artifacttype: Github, S3 or any of the supported artifiact repositories.

    • Username and Password: These are the credentials for accessing the repo that will be specified during the stage input.

Note: Ensure GIT Username & Password doesn't have ‘@’ included.

2.Create a secret from where TerraSpin Job will read the information provided in artifactaccount.json

kubectl create cm terraspinbackendconfig --from-file=artifactaccounts.json -n default => ”default”

The default namespace is the one that is planned for using the TerraSpin Jobs. Ensure that access to this namespace is limited as credentials are available here.

3. Create a file orca-local.yml with the following contents and replace ALL occurrences of:

  • account: Name of the spinnaker kubernetes account.

  • application: Name of the application in Spinnaker.

  • credentials: Provide the same Kubernetes Account Name provided above.

  • namespace (under metadata): Namespace where the Terraform Job should run. This should be the same namespace where terraspinbackendconfig configmap was created in (a) above.

4. Navigate to the following location:

~/.hal/default/profiles in halyard pod/machine

Copy the orca-local.yml file created above. In case an orca-local.yml already exists, please append the contents as appropriate.

5. Execute the following in halyard pod or on halyard machine:

hal deploy apply 

At this point spinnaker configuration for Terraform Customer Job stage is complete. Please wait for all pods to restart and stabilize.

Executing Terraform Scripts via the custom job stage

Once spinnaker configuration for Terraform Customer Job stage is complete, the following stages should be available in pipeline configuration:

  1. TSPlanJob

  2. TSApplyJob

  3. TSDestroyJob

TSPlanJob:

This stage does Terraform infra-code initial formal run basically (terraform init and terraform plan). This stage has the following five inputs.

  1. Tf Script Account : This must be one of the “account” values that is defined in artifactaccounts.json. You have to choose that account where your tf script is present.

  2. Terraform plan:

    • This is a location of Terraform Script.

    • Provide the location in the form of ‘username/repo-name.git//folder’.

    Note: The two // separating the repo and the folder containing the terraform root module script. E.g. for github: OpsMx/staging-terraform-pm.git//azure/k8cluster. The credentials for accessing this repo were provided in artifactaccounts.json.

  3. Override file (optional): If present, the file specified here will be applied on the root module. Possible use-case might be to provide a tfvars file.

    Note: If you would like to ignore this option, ensure the block is empty by removing the help text available

  4. Tf state account: This must be one of the “account” values that is defined in artifactaccounts.json.You have to choose that account where you want to store the tf state.

  5. State repo: This is repo where the terraform state files are stored and retrieved across multiple stages such as between plan and apply, apply and destroy. This is mandatory for the Terraform Custom Job Stage to function.

    Note: As state-information can contain credentials in plain-text, this repo should have control access. Same account name and their credentials will be used to access this repo (E.g. opsmx/staging-terraform-states.git).

  6. UUId: This can be any unique string based on user choice to identify the terraform state across multiple stages. It is not mandatory to have all the stages(TSPlan, TSApply, TSDestroy) in the same pipeline. However, they all should have the same UUid.

Output: This stage will show terraform init and plan command output.

TSApplyJob:

Functionality of this stage is to create terraform infra-code( terraform apply ). Here stage output will have properties with terraform infra-code output-values in a key-value format so that user can use those values in the next subsequent stage of pipeline this stage has four inputs.

  1. Artifact account

  2. Override file

  3. Tf State Account

  4. State repo

  5. UUId

Output: This stage will show terraform apply command output.

TSDestroyJob:

Functionality of this stage to destroy terraform infra-code basically ( terraform destroy ) this stage has four inputs.

  1. Tf State Account.

  2. State repo.

  3. UUId.

Output: This stage will show terraform destroy command output

Spinnaker Custom Job
artifactaccounts.json Available here
Orca-local.yml Available here