Appian Kubernetes Utilities

Overview

Appian on Kubernetes Utilities is a Python CLI toolkit that accelerates the deployment and management of Appian on Kubernetes (AoK) environments. It replaces manual YAML assembly and documentation with automated generation from a single configuration file, giving Appian administrators a low-barrier-to-entry path to production deployments.

Key Features & Functionality

  • Config Generator - simplify the preparation and deployment of the Appian Operator and other pre-requisites needed to deploy the Appian platform itself.
  • Config Visualization - convert your Appian on Kubernetes site YAML file into a Kubernetes diagram to visualize your configuration.
  • Migration Manifest Parser - enables customers migrating from machine-based Appian environments to Kubernetes using the Migration Tool to take advantage of the best-practice configurations provided by the Appian Platform (CS) Helm Chart.
Anonymous
  • v3.0.0 Release Notes

    This is a complete rewrite of the utilities as a single, installable Python package. The previous standalone scripts have been replaced by a unified CLI.
    What's new:
    • Unified CLI: Single aok command with subcommands (generate, visualize, migration-convert, docs). Install the wheel, get all utilities.
    • Offline documentation: Bundled MkDocs site with full search. Distributed as a companion zip for air-gapped environments.
    • Dependency detection: The visualizer now checks for Graphviz before rendering and provides platform-specific install instructions (macOS/Windows/Linux) instead of failing silently.
    • Config Generator: Database script output for all supported databases (MySQL, MariaDB, Oracle, PostgreSQL, SQL Server, DB2)
    • Config Generator: Draft appian-platform-cs Helm values file generation
    • Config Visualizer: RWO storage totals per component and site-wide in the resource summary
  • v3.0.0 Release Notes

    This is a complete rewrite of the utilities as a single, installable Python package. The previous standalone scripts have been replaced by a unified CLI.
    What's new:
    • Unified CLI: Single aok command with subcommands (generate, visualize, migration-convert, docs). Install the wheel, get all utilities.
    • Offline documentation: Bundled MkDocs site with full search. Distributed as a companion zip for air-gapped environments.
    • Dependency detection: The visualizer now checks for Graphviz before rendering and provides platform-specific install instructions (macOS/Windows/Linux) instead of failing silently.
    • Config Generator: Database script output for all supported databases (MySQL, MariaDB, Oracle, PostgreSQL, SQL Server, DB2)
    • Config Generator: Draft appian-platform-cs Helm values file generation
    • Config Visualizer: RWO storage totals per component and site-wide in the resource summary

  • v2.0.0 Release Notes

    • Updated all utilities to align with appian-platform-cs Helm chart version 2.0.0
    • Config Generator: Added Oracle template SQL script
    • Config Generator: Added default resource requests and limits to Operator resources
    • Config Generator: Database secret command now includes username key
    • Config Generator: Renamed `site.tshirtSize` values field to `site.class`
    • Config Visualization: Added httpd resources to diagram
    • Config Visualization: Added resource summary per component to command line output

  • v1.2.0 Release Notes

    • Removed support for `searchServerPassword` field in Config Generator and Migration Manifest Parser. From Operator v0.181.0, and Appian platform versions hotfixed from July 03, 2025 or later, the Operator now manages the Search Server password for you. Manually specifying a Search Server password is no longer required nor recommended.
    • Aligned with Appian Operator version v0.181.0 and above

  • v1.1.0 Release Notes

    • Config Generator: Support custom Appian Operator namespace
    • Fixed readme for installing ruamel.yaml
    • Config Generator: Fixed operator values path for main operator
    • Aligned with Appian Operator versions up to and including v0.178.0

  • v1.0.2 Release Notes
    • Migration Manifest Parser: Maps custom property `conf.appserver.minHeapSize` to field `webapp.minHeapSize` in line with changes in version 1.1.1 of the Appian Platform CS Helm chart.
  • v1.0.1 Release Notes
    • Migration Manifest Parser: No longer sets workerNodeTotalCpu or dataSources.mysqlDriverConfigMapName fields in line with changes in version 1.1.0 of the Appian Platform CS Helm chart.