Merge the minute and install plugin docs [#345]

teemtee · Sep 15, 2020 · 866afc7 · 866afc7
2 parents 9d0b887 + 7548040
commit 866afc7
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 0 deletions.
diff --git a/spec/steps/prepare.fmf b/spec/steps/prepare.fmf
@@ -26,6 +26,7 @@ description: |
  - /tmt/steps/provision/podman
  - /tmt/steps/provision/vagrant
  - /tmt/steps/provision/testcloud
+ - /tmt/steps/provision/minute
 
 /ansible:
  summary:
@@ -50,3 +51,47 @@ description: |
  - /tmt/steps/provision/podman
  - /tmt/steps/provision/vagrant
  - /tmt/steps/provision/testcloud
+ - /tmt/steps/provision/minute
+
+/install:
+ summary:
+ Install packages on the guest
+ description: |
+ One or more RPM packages can be specified under the
+ ``package`` attribute. The packages will be installed
+ on the guest. They can either be specified using their
+ names or paths to local rpm files.
+
+ Additionaly, the ``directory`` attribute can be used to
+ install all packages from the given directory. Copr
+ repositories can be enabled using the ``copr`` attribute.
+ It's possible to change the behaviour when a package is
+ missing using the ``missing`` attribute. The missing
+ packages can either be silently ignored ('skip') or a
+ preparation error is thrown ('fail'), which is the default
+ behaviour.
+
+ example: |
+ prepare:
+ how: install
+ package:
+ - tmp/RPMS/noarch/tmt-0.15-1.fc31.noarch.rpm
+ - tmp/RPMS/noarch/python3-tmt-0.15-1.fc31.noarch.rpm
+
+ prepare:
+ how: install
+ directory:
+ - tmp/RPMS/noarch
+
+ prepare:
+ how: install
+ copr: psss/tmt
+ package: tmt-all
+ missing: fail
+
+ implemented:
+ - /tmt/steps/provision/localhost
+ - /tmt/steps/provision/podman
+ - /tmt/steps/provision/vagrant
+ - /tmt/steps/provision/testcloud
+ - /tmt/steps/provision/minute
diff --git a/spec/steps/provision.fmf b/spec/steps/provision.fmf
@@ -97,3 +97,21 @@ example: |
  how: connect
  guest: hostname or ip address
  key: private-key-path
+
+/minute:
+ summary:
+ Provision a virtual machine using the 1minutetip OpenStack
+ backend
+ description: |
+ First check whether a prereserved machine exists using the
+ 1minutetip backend. Use it, if it exists, otherwise boot a
+ new machine using the OpenStack backend.
+
+ Note that you need to have the ``1minutetip`` script
+ installed in order for this provision method to work.
+ example: |
+ provision:
+ how: minute
+ image: 1MT-Fedora-32
+ flavor: m1.large
+ implemented: /tmt/steps/provision/minute.py