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.

Sign up for GitHub

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

Jump to bottom

(maint) - Update README #234

Merged
merged 1 commit into from
Jul 31, 2023
Merged

(maint) - Update README #234

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Provision

Simple tasks to provision and tear_down containers / instances and virtual machines.
Simple tasks to provision and tear down containers, instances and virtual machines.

#### Table of Contents

Expand All @@ -23,6 +23,7 @@ Provisioners so far:
* ABS (AlwaysBeScheduling)
* Docker
* Vagrant
* Provision Service

## Setup

Expand All @@ -32,7 +33,7 @@ Bolt has to be installed to run the tasks. Each provisioner has its own requirem

#### Running the tasks as part of puppet_litmus

Please follow the documentation here: https://puppetlabs.github.io/litmus/
Please follow the documentation here: https://puppetlabs.github.io/content-and-tooling-team/docs/litmus/

#### Running the module stand-alone call the tasks/plans directly

Expand All @@ -49,8 +50,8 @@ mod 'puppetlabs-puppet_conf'

There is a basic workflow for the provision tasks.

* provision - creates / initiates a platform and edits a bolt inventory file.
* tear_down - creates / initiates a system / container and edits a bolt inventory file.
* provision - creates/initiates a platform and edits a bolt inventory file.
* tear_down - creates/initiates a system/container and edits a bolt inventory file.

For extended functionality please look at the wiki https://github.com/puppetlabs/provision/wiki

Expand Down Expand Up @@ -125,7 +126,7 @@ Ran on 1 node in 1.54 seconds

### Docker

Given an docker image name it will spin up that container and setup external ssh on that platform. For helpful docker tips look [here](https://github.com/puppetlabs/litmus_image/blob/main/README.md)
Given an docker image name it will spin up that container and setup external ssh on that platform. For helpful docker tips look [here](https://github.com/puppetlabs/litmus_image/blob/main/README.md)

provision

Expand Down Expand Up @@ -281,7 +282,7 @@ bundle exec rake 'litmus:provision[provision::provision_service, centos-7-v20200

#### Synced Folders

By default the task will provision a Vagrant box with the [synced folder]() **disabled**.
By default the task will provision a Vagrant box with the [synced folder](https://developer.hashicorp.com/vagrant/docs/synced-folders) **disabled**.
To enable the synced folder you must specify the parameter `enable_synced_folder` as `true`.
Instead of passing this parameter directly you can instead specify the environment variable `LITMUS_ENABLE_SYNCED_FOLDER` as `true`.

Expand Down
Loading