Solution Manager Administration Guide¶

Table of Contents

• Preface
  • Scope
  • Who Should Use This Document
  • Summary of Contents
• Introduction
  • Architecture
• Starting the Solution Manager
• Introducing the Solution Manager Administration Tool
• License Management
  • Install a License
    • Check Global License Information
  • Assign Licenses
    • Assign a License to a Server
    • Check the License Information for an Environment
  • How Licenses Work
    • How a Server Resolves Its License
    • How Denodo Servers Behave on License Responses
  • License Usages Table
• Configuration
  • Setting-Up an External Database
    • Changing the Password of the External Database
  • VCS Configuration
  • Setting-Up the Informative Message
  • Global Monitoring Configuration
• Authentication and Authorization
  • User Management
  • Authenticating with LDAP
  • Authenticating with Single Sign-On
    • SAML Configuration
    • OAuth Configuration
    • OpenID Configuration
    • Kerberos Configuration
  • Authorization
    • Global Privileges
      • Global Administrator (global_admin)
      • Solution Manager Administrator (solution_manager_admin)
      • Promotion Administrator (solution_manager_promotion_admin)
      • Promotion Administrator for Specific Environments (solution_manager_promotion_admin_*)
      • Promotion (solution_manager_promotion)
      • Promotion for Specific Environments (solution_manager_promotion_*)
      • Monitor Administrators
    • Privileges Granted to a Role For an Environment
      • CONNECT
      • METADATA
      • WRITE
      • EXECUTION
      • MONITOR
      • DEPLOY
      • DEPLOY ADMIN
  • Role Management
    • Import roles from an LDAP server
• Denodo Security Token
  • Architecture
  • Configure the Denodo Platform Components to Reach the Security Token Server
  • Security Considerations
  • External Identity Provider Considerations
  • Configure the Connection to the Security Token Server from the Denodo Platform
  • Authentication Credentials
  • Single Sign-On Sequence
• Environments
  • Clusters
  • Working Modes
• Standard Mode
  • Creating Environments
  • Configuring Environments
  • Creating Standard Clusters
  • Configuring Clusters
• Automated Cloud Mode (AWS)
  • Configuring Mode
  • Creating Environments
  • Configuring Environments
  • Creating Clusters
    • Global Configuration
    • Servers Configuration
      • Load Balancing & Auto Scaling
      • EBS Storage
      • Advanced Options
  • Configuring Clusters
  • Managing Clusters
    • View the Cluster Summary
    • View the Progress of the Last Action
    • Enable a Cluster
    • Disable a Cluster
    • View All Cluster Events
    • Start a Cluster
    • Stop a Cluster
    • Restart a Cluster
    • Recreate a Cluster
    • Recreate a Cluster from Server
    • Install a Denodo Update in a Cluster
    • Monitor the Cluster with the Diagnostic & Monitoring Tool
• Environment Configuration
  • Configuring Virtual DataPort Properties
  • Configuring Deployments
    • Standard Mode Environments Deployments Configuration
    • Cloud Environments Deployments Configuration
    • Data Catalog Server Synchronization
  • Configuring Deployment Scripts (Standard Mode)
    • Examples of Deployment Scripts
  • Configuring Environment Logging Level
  • Configuring Environment Monitoring
• Clusters Configuration
  • Configuring Cluster Load Balancing Variables (Standard Mode)
  • Configuring Scheduler Properties
  • Configuring Cluster Logging Level
• Servers
  • Creating Servers
  • Configuring Servers
    • Configuring Server Load Balancing Variables (Standard Mode)
    • Configuring Server Logging Level
• Load Balancing Variables
  • Creating Load Balancing Variables
  • Assigning Values to Loading Balancing Variables
• Promotions
  • Creating Revisions
    • General Options
    • Additional Options
    • Revision Candidate Elements
      • Virtual DataPort Databases
      • Users and Roles
      • Scheduler Jobs
      • Elements Dependencies Tree
  • Create Revisions from VQL
  • Revisions Table
    • Create a Revision
    • Edit a Revision
    • See the Information of a Revision
    • Remove Revisions
    • Filter Revisions in the Table
    • Download the Metadata of a Revision
    • Validate a Revision
    • Check the Validation Summary of a Revision
    • Copy Revision
    • Deploy Revisions
    • Check the Environments Where a Revision Was Deployed
  • Standard Mode Deployments
    • Deployment Preconditions
    • Deployment Paradigms
      • Simple Deployment
      • Deployment Without Service Interruption
        • Active Passive Load Balancing Considerations
        • Deployment Without Service Interruption in a Single Cluster Environment
        • Deployment Without Service Interruption in a Several Clusters Environment
    • Cache Considerations
  • Cloud Deployments
    • Cloud Deployments Options
      • Without Minimizing Downtime
      • Minimizing Downtime
    • Cache Considerations
  • Considerations for Deployments
  • Deployments Table
    • Cancel Deployments
    • Filter Deployments in the Table
    • Check the Progress Summary of a Deployment
    • See the Errors of a Deployment
    • See the Revisions of a Deployment
    • Download Backup Data for a Deployment
  • Deployment Progress
• Monitoring
  • Monitoring Configuration
  • JDBC Logging Configuration
    • Kerberos Configuration
  • Cloud Storing Configuration
• Import and Export
• Appendix
  • REST API
    • Get the List of Environments
    • Create an Environment
    • Get the List of Licenses Available
    • Update an Environment
    • Delete an Environment
    • Update AWS Global Credentials
    • Update AWS Environment Credentials
    • Start Automated Mode Cluster
    • Stop Automated Mode Cluster
    • Restart Automated Mode Cluster
    • Recreate Automated Mode Cluster
    • Recreate From Servers Automated Mode Cluster
    • Install Denodo Update Automated Mode Cluster
    • Get the List of Virtual DataPort Properties Associated to an Environment
    • Create and Delete Environment Properties
    • Get the List of Clusters
    • Create a Cluster
    • Get a Cluster
    • Update a Cluster
    • Delete a Cluster
    • Get the List of Scheduler Properties Associated to a Cluster
      • Optional Request Parameters to Filter Cluster Properties
    • Create and Delete Cluster Properties
    • Get the List of Servers
    • Create a Server
    • Get a Server
    • Update a Server
    • Delete a Server
    • Export Solution Manager Catalog and Configuration
    • Import Solution Manager Catalog and Configuration
    • Get the List of Revisions
    • Create a Revision from a VQL File
    • Get the List of Deployments
    • Start a New Deployment from a List of Revisions
    • Get the Progress of a Deployment
    • Free License Usage
    • Free License Usage by Server Id
    • Ping License Manager Server
    • Ping to Solution Manager Server
  • Best Practices: Deployment of Updates Across Your Organization
    • Updating Solution Manager with High Availability
  • Solution Manager Compatibility with the Denodo Platform Servers
  • Creating A Custom AMI for the Denodo Platform
  • Suggested Reading Materials to Use the Automated Cloud Mode
  • Architecture of a Deployment of Solution Manager in AWS
  • Best Practices for Automated Mode AWS Environments
    • Maximizing Uptime and High Availability
    • AWS Infrastructure Deployment Considerations
    • Health Checks
    • Backup and Recovery
    • Restoring Backup
    • Maintenance
  • AWS - Creating a Backup
  • Creating an IAM Policy
    • Main Features
    • Automated VPC Management
    • Automated Subnet Management
    • Automated Auto Scaling Group Management
    • Automated Security Group Management