RiotKit Do
Contents:
Beginners guide - on YAML syntax example
Extended usage - Makefile in Python syntax
Commandline basics
Importing tasks
ADVANCED usage
Troubleshooting
Loading priority
Tasks development
Global environment variables
Custom distribution
Tasks API
Working with YAML files
Creating installer wizards with RKD
Good practices
Process isolation and permissions changing with sudo
Docker entrypoints under control
Testing with unittest
Built-in tasks
RiotKit Do
Docs
»
ADVANCED usage
Edit on GitHub
Next
Previous
ADVANCED usage
ΒΆ
Troubleshooting
Loading priority
Environment variables loading order from .env and from .rkd
Environment variables loading order in YAML syntax
Order of loading of makefile files in same .rkd directory
Paths and inheritance
Tasks execution
Tasks development
Option 1) Simplest - in YAML syntax
Option 2) For Python developers - task as a class
Option 3) Quick and elastic way in Python code of Makefile.py
Please check
Tasks
API
for interfaces description
Global environment variables
RKD_WHITELIST_GROUPS
RKD_ALIAS_GROUPS
RKD_UI
RKD_AUDIT_SESSION_LOG
RKD_BIN
Custom distribution
Example
Read more in
global
environment
variables
Tasks API
Each task must implement a TaskInterface
To include a task, wrap it in a declaration
To create an alias for task or multiple tasks
Execution context provides parsed shell arguments and environment variables
Interaction with input and output
Storing temporary files
Testing
Working with YAML files
YAML parsing API
FAQ
API
Creating installer wizards with RKD
Concept
Example Wizard
Using Wizard results internally
Example of loading stored values by other task
API
Good practices
Do not use os.getenv()
Define your environment variables
Use sh(), exec(), rkd() and silent_sh()
Do not print if you do not must, use io()
Process isolation and permissions changing with sudo
Mechanism
Permissions changing with sudo
Future usage
Docker entrypoints under control
Environment variables
Arguments propagation
Tasks customization
Massive files rendering with JINJA2
Privileges dropping
Testing with unittest
Example: Running a task on a fully featured RKD executor
Example: Mocking RKD-specific dependencies in TaskInterface
Documentation
Read the Docs
v: v2.2.1
Versions
latest
stable
v2.2.1
v2.2.0
v2.1.5
v2.1.4
v2.1.3
v2.1.2
v2.1.1
v2.1.0
v2.0.0.0
v1.1
v0.7.0.0b1
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.