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 - more examples
  • 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
  • RKD_DIST_NAME
  • RKD_SYS_LOG_LEVEL
  • RKD_IMPORTS
  • RKD_DEPTH
• Custom distribution
  • Example
  • Read more in global environment variables
  • Customizing RKD resource files
• Tasks API
  • Each task must implement a TaskInterface (directly, or through a Base Task)
  • 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
  • Parsing RKD syntax
  • 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
• Best practices
  • Do not use os.getenv()
  • Define your environment variables
  • Use sh() and exec() to invoke commands
  • Do not print if you do not must, use io()
  • Use tasks expansion or pipelines instead of dynamic tasks creation in Makefile
  • Invoke RKD subtasks as a pipeline or tasks expansion
  • Don’t mix dependencies between subprojects - rethink project structure
  • Keep compilation and configuration stage fast
  • Use configuration stage for validation
• 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 PyTest
  • Example: Running a task on a fully featured RKD executor
  • Example: Mocking RKD-specific dependencies in TaskInterface
  • API
• org.riotkit.rkd/yaml/v1 schema