Tutorials

Contents:

• Installing the development environment
  • RPM packages installation
  • Virtualenv installation
    • A screen cast of the steps above
• Creating a new repository for actor development
  • A screen cast of the steps above
• Creating your first actor
  • Getting started
    • Creating a tag
      • Screencast
    • Creating a topic
      • Screencast
    • Creating a model
      • Screencast
    • Creating an actor
      • Screencast
• How to create a Leapp actor for RHEL 7 to 8 upgrade
  • Introduction
  • Setting up the development environment
  • Tools
    • leapp
    • snactor
  • Creating an actor
  • Including an actor in the RHEL 7 to 8 upgrade process
  • Inter-actor communication
    • Receiving data from other actors
    • Asking user questions
    • Producing data for other actors and reporting
    • Reporting tips and good practices
  • Testing your new actor
    • Executing a single actor
    • Executing a single actor that uses the workflow config
    • Executing the whole upgrade workflow with the new actor
    • Verifying correct communication between actors
  • Writing tests for an actor
  • Best practices
  • Contributing actors to the Leapp project
  • FAQ
    • In which existing workflow phase should I place my new actor?
    • How to stop the upgrade in case my actor finds a problem with the system setup?
    • How to stop execution of my actor in case of an unexpected error?
    • How does the logging work?
    • What Python version my actor/tests code should be compatible with?
    • How to add tests to my new actor?
    • How to use libraries or data files in my new actor?
    • Where can I report an issue or RFE related to the framework or other actors?
      • Leapp framework
      • Leapp actors
  • Where can I seek help?
• How to properly inhibit the RHEL 7 to 8 upgrade process
  • Process Inhibition
    • Sample Actor
• Using messaging to send data between actors
  • Creating the ResolvedHostname model
  • Creating a message consuming actor
  • Storing messages in the repository data for reuse
  • Testing the new actor
    • Screencast
• Asking user questions
  • Creating the dialog
  • Using the dialog and the answers
  • Explaining the dialogs processing mechanism during the upgrade
• Linking repositories
  • A screen cast of the steps above
• Working with workflows
  • Creating a workflow
  • Defining workflow phases
  • Testing the workflow execution
  • Adding an actor to a workflow
• Workflow APIs
  • Using Workflow APIs
  • General workings of the Workflow API feature
  • Defining Workflow APIs
    • Working with messages
    • Tests
    • Dependencies
  • API definition best practises
    • Be always explicit about what messages the API consumes or produces
    • Keep API interfaces small and on the same topic
    • Use lazy evaluation and caching for messages consumed to improve efficiency
    • Write tests that verify API contract compliance
• Writing tests for actors
  • Getting started with writing tests
    • Naming conventions
    • Writing tests that execute the whole actor - component tests
      • Fixtures
      • Testing actors that modify the OS
    • Testing private actor library - unit tests
    • Using repository resources during test runtime
    • Actors‘s test dependencies
  • Running the tests
    • Preparing the environment
    • Actor‘s tests
    • Shared libraries‘ tests
• Debugging actors
  • Snactor
  • PyCharm / rpdb
• Deprecation
  • List of the deprecated functionality in leapp
  • current upstream development (till the next release + 6months)
  • v0.15.0 (till Mar 2023)
  • What is covered by deprecation process in leapp?
  • What does it mean that something is deprecated?
  • What is the deprecation process for leapp?
  • How do I find out what is deprecated?
  • How to deprecate entities in leapp?
    • Examples of a model deprecation
    • Example of a model replacement
    • Example of a derived model deprecation
  • Additional various outputs of snactor and leapp
    • snactor warning message example
    • leapp report example entries
  • Additional simple usage examples of @deprecated
    • Functions
    • Models
    • Classes