Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tutorial for Workflow APIs #618

Merged
merged 1 commit into from
Mar 16, 2020
Merged

Conversation

vinzenz
Copy link
Member

@vinzenz vinzenz commented Mar 11, 2020

This patch adds a basic tutorial for Workflow APIs how to use them, how
to define them and some best practises for them.

Signed-off-by: Vinzenz Feenstra vfeenstr@redhat.com

docs/source/workflow-apis.md Outdated Show resolved Hide resolved
docs/source/workflow-apis.md Outdated Show resolved Hide resolved
docs/source/workflow-apis.md Show resolved Hide resolved
@pirat89
Copy link
Member

pirat89 commented Mar 11, 2020

And I am still missing explanation what the workflow API is and what is the purpose of it. I can read it, but from the point of users, it's not so clear why they should be interested about the workflow APIs. As well, it's mentioned only in tutorial but it should be mentioned on more places. If there is no time for that now, create please issue so we will not froget about that.

pirat89
pirat89 previously approved these changes Mar 12, 2020
Copy link
Member

@pirat89 pirat89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@pirat89
Copy link
Member

pirat89 commented Mar 12, 2020

oh crap. I didn't want to create merge commit.

@pirat89 pirat89 dismissed their stale review March 12, 2020 16:10

just dimissing my review to wait for rebase

@Rezney
Copy link
Member

Rezney commented Mar 16, 2020

@vinzenz pls rebase

This patch adds a basic tutorial for Workflow APIs how to use them, how
to define them and some best practises for them.

Signed-off-by: Vinzenz Feenstra <vfeenstr@redhat.com>
@pirat89 pirat89 merged commit 33513ee into oamg:master Mar 16, 2020
pirat89 added a commit to pirat89/leapp that referenced this pull request Apr 7, 2020
## Packaging
- Add BuildRequires on python2-setuptools
- Add new dependency on python?-requests
- Add unversioned dependency on leapp-repository and provide
  the leapp-framework capability in python2-leapp (see docs about
  "new dependency mechanism") (oamg#591)
- Move all leapp and snactor files into related rpms istead of python?-leapp (oamg#591)
- Remove dependency on Jinja2

## Framework
### Fixes
- Fix json export capabilities using serialization (oamg#598)

### Enhancements
- Add the DESKTOP tag for the leapp report (oamg#612)
- Dialogs are non-interactive and redesigned significantly; but in beta support
  (see the known issue)
- Introduce DialogModel that could be processed by actors to add related
  information into the report (oamg#589)
- Introduce Workflow API (see the tutorial) (oamg#618)
- Report inhibitors seprately from errors on stdout (oamg#620)
- Show progress in non verbose executions (oamg#621)

### Known issue
- The answerfile is not generated on some machines after the run of leapp.
  Currently it's under investigation and it will be fixed definitely in the
  next release.

## Leapp
### Fixes
- Print message about generated report when `leapp upgrade` ends, as we do for
  `leapp preupgrade` (oamg#573)

### Enhancements
- Add `leapp answer` to answer Dialog questions on CLI (oamg#592)
- Add the --no-rhsm option for (pre)upgrade commands (oamg#622)
- Display warning when leapp is used in unsupported (devel/testing) mode (oamg#577)
- Print errors on stdout in pretty format (oamg#593)
- The error messages are part of the preupgrade report
- The verbosity options (--verbose | --debug) are available for leapp commands as well

## Snactor
### Fixes
### Enhancements

## stdlib
### Fixes

### Enhancements
- Add `stdin` and `encoding` parameters in the run function (oamg#583, oamg#595)

## Modifications
- Code is compatible with Python3 pylint
pirat89 added a commit to pirat89/leapp that referenced this pull request Apr 16, 2020
## Packaging
- Add BuildRequires on python2-setuptools
- Add new dependency on python2-requests
- Add unversioned dependency on leapp-repository and provide
  the leapp-framework capability in python2-leapp (see docs about
  "new dependency mechanism") (oamg#591)
- Move all leapp and snactor files into related rpms instead of python?-leapp (oamg#591)
- Remove dependency on Jinja2

## Framework
### Fixes
- Fix json export capabilities using serialization (oamg#598)

### Enhancements
- Add the DESKTOP tag for the leapp report (oamg#612)
- Dialogs are non-interactive and redesigned significantly; but in beta support
  (see the known issue)
- Introduce DialogModel that could be processed by actors to add related
  information into the report (oamg#589)
- Introduce Workflow API (see the Workflow APIs tutorial) (oamg#618)
- Report inhibitors separately from errors on stdout (oamg#620)
- Show progress in non-verbose executions (oamg#621)

### Known issue
- The answerfile is not generated on some machines after the run of leapp.
  Currently it's under investigation.

## Leapp
### Fixes
- Print message about generated report when `leapp upgrade` ends, as we do for
  `leapp preupgrade` (oamg#573)

### Enhancements
- Add `leapp answer` to answer Dialog questions in CLI (oamg#592)
- Add the --no-rhsm option for (pre)upgrade commands (oamg#622)
- Add the --enablerepo option for Leapp to use an existing custom yum/dnf
repository during the upgrade
- Display a warning when leapp is used in an unsupported (devel/testing) mode (oamg#577)
- Print errors on stdout in pretty format (oamg#593)
- Error messages are now part of the preupgrade report
- The verbosity options (--verbose | --debug) are available for leapp commands as well

## stdlib
### Enhancements
- Add `stdin` and `encoding` parameters in the run function (oamg#583, oamg#595)

## Modifications
- Code is compatible with Python3 pylint
@pirat89 pirat89 mentioned this pull request Apr 16, 2020
pirat89 added a commit that referenced this pull request Apr 16, 2020
## Packaging
- Add BuildRequires on python2-setuptools
- Add new dependency on python2-requests
- Add unversioned dependency on leapp-repository and provide
  the leapp-framework capability in python2-leapp (see docs about
  "new dependency mechanism") (#591)
- Move all leapp and snactor files into related rpms instead of python?-leapp (#591)
- Remove dependency on Jinja2

## Framework
### Fixes
- Fix json export capabilities using serialization (#598)

### Enhancements
- Add the DESKTOP tag for the leapp report (#612)
- Dialogs are non-interactive and redesigned significantly; but in beta support
  (see the known issue)
- Introduce DialogModel that could be processed by actors to add related
  information into the report (#589)
- Introduce Workflow API (see the Workflow APIs tutorial) (#618)
- Report inhibitors separately from errors on stdout (#620)
- Show progress in non-verbose executions (#621)

### Known issue
- The answerfile is not generated on some machines after the run of leapp.
  Currently it's under investigation.

## Leapp
### Fixes
- Print message about generated report when `leapp upgrade` ends, as we do for
  `leapp preupgrade` (#573)

### Enhancements
- Add `leapp answer` to answer Dialog questions in CLI (#592)
- Add the --no-rhsm option for (pre)upgrade commands (#622)
- Add the --enablerepo option for Leapp to use an existing custom yum/dnf
repository during the upgrade
- Display a warning when leapp is used in an unsupported (devel/testing) mode (#577)
- Print errors on stdout in pretty format (#593)
- Error messages are now part of the preupgrade report
- The verbosity options (--verbose | --debug) are available for leapp commands as well

## stdlib
### Enhancements
- Add `stdin` and `encoding` parameters in the run function (#583, #595)

## Modifications
- Code is compatible with Python3 pylint
MichalHe pushed a commit to MichalHe/leapp that referenced this pull request Aug 12, 2021
## Packaging
- Bump required leapp-framework capability to 1.4 (oamg#642)

## Upgrade handling
### Fixes
- Fix comparison of the newest installed and booted kernel (oamg#600)
- Fix remediation command for ipa-server removal (oamg#617)
- Fix crash due to missing network interfaces during upgrade phases (oamg#625)
- Fix error with /boot/efi existing on non-EFI systems (oamg#627)
- Fix false positive detection of issue in /etc/default/grub that led into GRUB prompt (oamg#587)
- Fix syntax error in upgrade script (oamg#619)
- Inhibit upgrade with mount options in fstab that break mounting on RHEL 8 (oamg#639)
- Inhibit upgrade on s390x machines with /boot on a separate partition (oamg#641)
- Inhibit upgrade if multiple kernel-debug pkgs are installed (oamg#599)
- Remove the initial-setup package to avoid it asking for EULA acceptance during upgrade (oamg#626)
- Remove the *leapp-resume* service after the *FirstBoot* phase to prevent kill of the leapp process on `systemctl daemon-reload` (oamg#611)

### Enhancements
- Add upgrade support for SAP HANA (own upgrade path) (oamg#503)
- Allow upgrade with SCA enabled manifest (oamg#615)
- Add actors to migrate Quagga to FRR (oamg#467)
- Add stable uniq Key id for every dialog (oamg#618)
- Respect the *kernel-rt* package (oamg#600)

## Additional changes interesting for devels
- Add a possibility to overwrite virtualenv name using `$VENVNAME` (oamg#613)
- Update product certificates for RHEL 8.3 GA and 8.4 Beta/HTB (oamg#624)

Related leapp release: https://github.com/oamg/leapp/releases/tag/v0.12.0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants