Welcome to idem’s documentation!

• Idem
  • What does Idempotent mean?
  • How Does This Language Work?
  • Paradigms and Languages, This Sounds Complicated!
• Config Template
• idem doc
  • doc
  • file
  • start_line_number
  • end_line_number
  • ref
  • contracts
  • parameters
    • Examples
• Extending Idem
  • What is POP?
  • Lets Get Down to Business
  • Making Your First Idem State
• Adding Requisites
• SLS Metadata
  • SLS Level Metadata
  • ID Level Metadata
• SLS Structure
  • Core Components
    • ID Declaration
    • Path Reference
    • Arguments
    • Name and Names
    • Order
  • Requisites
    • Requisite Ins
  • Top Level Keys
    • Include
    • Extend
• SLS Parameters
  • Creating a parameter file
  • Calling parameters from a state
  • Default parameter values
  • Missing parameter values
  • Running an SLS state file and parameter file
  • Running an SLS state file and multiple parameter sources
  • Parameter precedence
• SLS Parameter Validation
  • Goal
  • Limitation
  • Overview of the process involved
    • Step 1:- Transformation
    • Step 2:- Extraction of parameters
    • Step 3:- Tallying with meta section in SLS
    • Step 4:- Remapping transformed strings original values
  • Sample Output
  • Some Additional Samples
• Argument Binding References
  • Indexes
  • “Resource” Contract
  • Arg_bind Requisites
• SLS Inversion
  • Motivation
  • State Requisite Handling
    • Normal Run
    • Inverted Run
  • Requirement
  • Limitations
    • Argumnet binding does not work
• JMESpath
  • Practicing with Static Data
  • Examples
  • Learn More
• Transparent Requisites
  • Unique Transparent Requisite
• Secure Multiple Account Management
  • Static Account Management
  • ACCT RENDER PIPES
  • UNENCRYPTED ACCT FILE
  • ALLOWED_BACKEND_PROFILES
  • ACCT SERIAL PLUGIN
• ACCT FILE
  • providers
  • acct plugins
  • profiles
  • backends
  • extras
• ignore_changes Requisite
• recreate_on_update Requisite
  • Greenfield Example 1
  • Brownfield Example 1
  • Brownfield Example 2
  • Greenfield Example 2
• Using a delay between states to resolve Jinja template argument binding
  • Fetching argument binding reference values
• Delayed rendering
  • Closing a delayed state block
• Sensitive Requisite
• SLS ACCT
  • Aggregate State
  • Single-use Profiles
  • Copy From Existing Profiles
• SLS Sources
• The SLS Tree
• Exec State
• SLS Resolver Plugins - hub.source
• Group plugins - hub.group
  • Finding Group Plugins
  • Using Group Plugins
  • Creating a Group Plugin
• Reconciliation Loop
  • Reconciler Plugin
  • Loop Implementation
  • Reconciliation Wait Time
    • Static
    • Random
    • Exponential
  • Pending plugin
  • CLI
  • Batch Function
  • Notes
• Enforced State Management
  • Local cache
  • Idem states
  • Unlock Idem state run
  • context
  • Writing an ESM plugin
  • refresh
  • restore
• Progress Bar
  • Configuration
  • CLI
  • Examples
    • Basic progress bar
    • Reconciliation
    • Displaying separate progress bars
  • Progress bars in PyCharm
• Count
• Events
  • Firing Events
    • from code
    • from jinja/sls
  • Event Profiles
    • idem-*
    • idem-status
    • idem-low
    • idem-high
    • idem-state
    • idem-chunk
    • idem-run
    • idem-exec
    • logger
• Kubernetes CRD support
  • CRD format
  • Execution
• Idem scripts
• Idem describe
  • State file path as input
  • Regular expression as input
  • Filtering
• Tutorials
  • Write To File Function
  • Template Render Function
  • Sleep Function
  • Trigger State in Idem
    • Example
• Single Target
• Tutorials
  • Example Tutorial
• Microsoft Azure Cloud Provider
• Migrating Support From Salt
  • Exec Modules and State Modules
    • salt/modules to exec
    • salt/states to states
    • salt/utils to exec
  • Namespaces
  • Exec Function Calls
  • States Function Calls
  • Full Function Example
    • Salt Function
    • Idem State Function
• Releases
  • Idem Release 3
    • Now Pluggable!
    • Runs Standalone!
    • Code Sources are Pluggable
    • Rendering is Separate
    • Idem is a Language Runtime
  • Idem 4 - Beyond Salt
    • Late Rendering With Render Blocks
    • Transparent Requisites
  • Idem 5 - Encrypted Secrets
  • Idem 5.1
  • Idem 6
    • Mod System
    • Listen
    • Any and All Requisites
  • Idem 7
    • New CLI
    • The Acct system
  • Idem 7.1
  • Idem 7.4
  • Idem 12.0.0
    • Recursive Contracts for exec/state returns
    • Kwarg Credentials for internal batch runs
    • Get status of internal batch run
  • Idem 12.0.2
  • Idem 13.0.0
    • Describe Subcommand
    • Implementing describe functionality
  • Idem 14.0.0
    • Auto State
    • Soft Fail
    • Returns
    • Resource
  • Idem 15.0.0
    • Reconciler Plugin
    • CLI
    • LOOP
  • Idem 15.0.1
  • Idem 16.0.0
    • Writing an ingress plugin
    • Setting up credentials
    • from code
    • from jinja/sls
  • Idem 17.0.0
  • Argument Binding References
    • Indexes
    • “Resource” Contract
    • Arg_bind Requisites

Get involved

• Contributing Guide
  • TL;DR Quickstart
  • Ways to contribute
  • Overview of how to contribute to this repository
  • Prerequisites
  • Fork, clone, and branch the repo
  • Set up your local preview environment
  • Sync local master branch with upstream master
  • Preview HTML changes locally
  • Testing a pop project
  • Contribution Guidelines
• License

Indices and tables

• Index

• Module Index

• Search Page