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
  • Overview
  • Prerequisites
  • Halyard Installation
  • Install Halyard on Debian/Ubuntu or macOS
  • Install Halyard on Docker
  • Configuring Cloud Service Providers
  • Configure the Storage Service

Was this helpful?

  1. Additional Resources
  2. Previous releases
  3. Spinnaker

Spinnaker Installation

PreviousSpinnaker ArchitectureNextSpinnaker Application

Last updated 2 years ago

Was this helpful?

The instructions listed below will help you install an open-source Spinnaker. If you want to install OpsMx Enterprise for Spinnaker (OES), please refer to the following page.

Overview

Now that we have the basic idea about Spinnaker, the concepts of Spinnaker and the architecture of Spinnaker, let’s learn how to install and configure Spinnaker to use it in production.

By the end of this chapter, you should be able to:

  • Install Spinnaker

  • Configure Spinnaker

Prerequisites

  • A local machine, VM or Docker container to install Halyard. A minimum of 12GB of memory should be available on the system.

  • The Spinnaker will be installed on a Kubernetes cluster. It is recommended to make a minimum of 4 cores and 16GB of RAM available to the cluster.

  • Java 11

Halyard Installation

Halyard, a command-line administration tool, is used to manage the entire lifecycle of Spinnaker deployment. This includes writing and validating the deployment's configuration, updating the deployment, and deploying each Spinnaker microservice. Spinnaker requires Halyard to install, configure, and update Spinnaker for all production-ready deployments.

There are two ways to install a halyard as follow:

  • Locally on Debian/Ubuntu or macOS

  • On Docker

"Install Halyard on Debian/Ubuntu or macOS" or "Install Halyard on Docker" depending on which option you prefer.

Install Halyard on Debian/Ubuntu or macOS

Please note that Halyard will only run on:

  • Ubuntu 14.04, 16.04 or 18.04 (Ubuntu 16.04 requires Spinnaker 1.6.0 or later)

  • Debian 8 or 9

  • macOS (tested on 10.13 High Sierra only)

  1. Download the latest Halyard version:

    • For Debian/Ubuntu:

    curl -O \
    https://raw.githubusercontent.com/spinnaker/halyard/master/install/debian/InstallHalyard.sh
    • For macOS:

    curl -O \
    https://raw.githubusercontent.com/spinnaker/halyard/master/install/macos/InstallHalyard.sh
  2. After downloading, install the latest version of Halyard:

    sudo bash InstallHalyard.sh
  3. Run the below command to check the status of the installation:

    hal -v

    The above command will display the version of Halyard.

Install Halyard on Docker

  1. Before you start, make sure Docker CE is installed on the machine. Run the following command:

    $ sudo systemctl status docker
  2. Create a local Halyard config directory in your machine using the following command:

    mkdir ~/.hal
  3. Start Halyard in a new Docker container. Use the below command to create the Halyard Docker container, mounting the Halyard config directory:

    docker run -p 8084:8084 -p 9000:9000 \
    --name halyard --rm \
    -v ~/.hal:/home/spinnaker/.hal \
    -it \
    us-docker.pkg.dev/spinnaker-community/docker/halyard:stable
  4. Connect to Halyard in a separate shell to run the specific micro-services using the command below:

    docker exec -it halyard bash
  5. Run the command below to enable command completion:

    source <(hal --print-bash-completion)
  6. To check the status of the installation run the following command:

    $ sudo docker stats

Configuring Cloud Service Providers

Cloud Platforms and Spinnaker Accounts

The next step is to select and configure the cloud platforms where you want to deploy the applications. Supported providers are:

  • App Engine

  • Amazon Web Services

  • Azure

  • Cloud Foundry

  • DC/OS

  • Google Compute Engine

  • Kubernetes

  • Oracle

You'll also need to register for cloud platform credentials. These credentials are called accounts in Spinnaker. Spinnaker uses the accounts to deploy the applications. To work with Spinnaker, enable at least one cloud platform and add at least one account. Adding an account instructions can be found later in this chapter (Choosing the Environment > Distributed Installations).

Choosing the Environment

Where Should Spinnaker be Installed?

Now it is time to configure the environment in which Spinnaker will be installed. In this step, you tell Halyard the environment where you want to install Spinnaker. The three distinct environments are as follows:

Distributed installation on Kubernetes: Halyard deploys each of Spinnaker's microservices separately in this environment. Highly recommend this for use in production.

Distributed Installations:

Distributed installations are useful for organizations with huge resource footprints, and they can’t afford downtime while Spinnaker is updating.

You must first set up the cloud provider for the environment. We'll use Kubernetes in this example. After that, you'll need to add a Spinnaker account, as previously mentioned.

Configure Kubernetes

Prerequisites:

  • A kubeconfig file: The kubeconfig file authenticates Spinnaker against the cluster. After authentication, read/write access to the resources is granted.

  • kubectl CLI tool: Spinnaker depends on kubectl to manage all API access. Along with Spinnaker, it's installed.

Adding an Account

A Spinnaker account always maps to the credential that authenticates the Kubernetes cluster.

Follow the steps below to add an account:

  1. First, enable the provider using the command below:

    hal config provider kubernetes enable
  2. Add the account using the command below:

    CONTEXT=$(kubectl config current-context)
    hal config provider kubernetes account add my-k8s-account \
        --context $CONTEXT

Follow the steps below after you've configured Kubernetes:

  1. Use the $Account name created while configuring the provider and run the command below:

    hal config deploy edit --type distributed --account-name \ $ACCOUNT
  2. Update the $PATH to make sure Halyard can find it. If Halyard was already running, restart it to pick up the new $PATH:

    hal shutdown

Local Debian

In this type of installation, Spinnaker is downloaded and run on the single machine where Halyard is installed.

  • At least four cores and 16GB of RAM are recommended.

  • Local Debian installation requires Ubuntu 14.04 or 16.04

Required Halyard invocations

Halyard is, by default, installed to a local Debian when first run. So, no changes are required from your end.If Halyard's deployment type has been changed and you want to go back to a local installation, run the command below.

hal config deploy edit --type localdebian

Intended use case:

The Local Debian installation is intended for smaller Spinnaker deployments and clouds where the Distributed installation is not yet supported; however, since all services are on a single machine, there will be downtime when Halyard updates Spinnaker.

Local Git

The Local Git installation means Spinnaker will be cloned, built, and run on the same single machine Halyard is run on.

Prerequisites

  • At least four cores and 16GB of RAM are recommended.

Install local dependencies

Make sure you have the following software installed on your computer:

Ubuntu

  • git: sudo apt-get install git

  • curl: sudo apt-get install curl

  • netcat: sudo apt-get install netcat

  • redis-server: sudo apt-get install redis-server

OpenJDK 8 - JDK (we’re building from source, so a JRE is not sufficient)

sudo add-apt-repository ppa:openjdk-r/ppa
sudo apt-get update
sudo apt-get install openjdk-8-jdk
curl -o- 
https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
# Follow instructions at end of script to add nvm to ~/.bash_rc
nvm install v12.16.0

MacOS

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • git: brew install git

  • curl: brew install curl

  • netcat: brew install netcat

  • redis-server:

    • Install: brew install redis

    • Start: brew services start redis

OpenJDK 8 - JDK (we’re building from source, so a JRE is not sufficient)

brew cask install adoptopenjdk/openjdk/adoptopenjdk8
curl -o- 
https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
# Follow instructions at end of script to add nvm to ~/.bash_rc

nvm install v12.16.0

Fork all Spinnaker repos

Setup SSH keys

Follow these guides to setup SSH access to your github.com account from your local machine:

  • Generating a new ssh key and adding it to your ssh agent

Required Halyard invocations

Halyard defaults to a Local Debian install when first run. If you will be contributing code to the Spinnaker project, you can change your deployment type to Local Git type and set up your development environment with the latest code.

hal config deploy edit --type localgit --git-origin-user=<YOUR_GITHUB_USERNAME
hal config version edit --version branch:upstream/master

Intended use case

The Local Git installation is intended for developers who want to contribute to Spinnaker. It is not intended to be used to manage any production environment.

NOTE: Be sure to use the same username here that you forked the Spinnaker repository.

Configure the Storage Service

Supported Storage Providers

Spinnaker requires an external storage provider to keep track of application settings and configured pipelines. Since this type of data is extremely sensitive and precious if lost, it is recommended that you use a trusted hosted storage solution.

The storage provider will not affect the cloud provider. For example, use Google Cloud Storage as a storage source but deploy to Microsoft Azure. The following storage providers are supported:

  • Azure Storage

  • Google Cloud Storage

  • Minio

  • Redis

  • S3

  • Oracle Object Storage

Deploy Spinnaker and Connect UI

Now you can select a Spinnaker version, start deploying it, and connect to it once it's finished.

Let’s select a Spinnaker version and deploy it.

  1. To view the list of available versions, run the command below:

    hal version list
  2. To set the version, run the command below:

    hal config version edit --version $VERSION
  3. Run the command below to deploy Spinnaker:

    hal deploy apply

    Once Spinnaker is deployed you can now connect to the Spinnaker UI.

  4. Run the command below:

    hal deploy connect
  5. Navigate to localhost:9000.

Local installations of Debian packages: This type of installation is best for small Spinnaker deployments. Spinnaker is currently hosted on a single machine, but it will be unavailable once it is updated. For more details click .

Local Git installations from Github: You can also install the Local Git from GitHub.This is suggested if you want to contribute to Spinnaker. For more details click .

Note that a Halyard cannot be used as a Local Debian base image because it does not contain the necessary packages to run Spinnaker

node (version >=12.16.0, can be installed via , summarized below)

yarn: npm install -g yarn or

brew (a package manager for MacOS, can be installed via , summarized below)

node (version >=12.16.0, can be installed via , summarized below)

yarn: npm install -g yarn or

Fork all of the microservices listed here: on github ( ).

Adding a new ssh key to your Github account. Refer .

For a short guide to getting up and running with developing Spinnaker, see the .

here
here
Docker installation
nvm
guide
here
nvm
guide
Spinnaker Microservices
guide
Here
developer setup guide
ISD/Spinnaker (OES) 3.12 Quick InstallationOpsMx
Logo