<commit_before>Vcloud-tools guide
============

A collection of tools that support automation of VMWare VCloud Director

## [Vcloud Launch][vcloud-launch]
A tool that takes a YAML configuration file describing a vDC, and provisions
the vApps and VMs contained within.

## [Vcloud Walker][vcloudwalker]
A tool that reports on the current state of an environment

## [Configure edgegateway services][edgegateway]
Examples of fog usage to configure Edge Gateway Services

## [Tag search][tag_search]
A tool that will perform operations on a set of Vapps that match the given tags.

Required set-up
===============

VCloud-tools is based around [fog].

To use it you need a `.fog` file in your home directory.

For example:

    test:
      vcloud_director_username: 'username@org_name'
      vcloud_director_host: 'api.vcd.portal.skyscapecloud.com'
      vcloud_director_password: 'password'

Unfortunately current usage of fog requires the password in this file.

## Troubleshooting

To troubleshoot fog related issues, set environment variables DEBUG or EXCON_DEBUG.
For more details see: http://fog.io/about/getting_started.html#debugging.

## Testing

To run the unit tests: `bundle exec rake spec`

To run the integration tests: `bundle exec rake integration_test`.
You need access to an environment as the integration test actually spins up a
VM. The easiest thing to do is create a local shell script called
`vcloud_env.sh` and set the contents:

    export FOG\_CREDENTIAL=test
    export VCLOUD\_TEST\_VDC="Name of the VDC"
    export VCLOUD\_TEST\_CATALOG="catalog-name"
    export VCLOUD\_TEST\_TEMPLATE="name-of-template"

Then run this before you run the integration test.


[vcloudwalker]: https://github.com/alphagov/vcloud-walker
[edgegateway]: docs/edgegateway.md
[tag_search]: docs/tag_search.md
[vcloud-launch]: docs/vcloud-launch.md
[fog]: http://fog.io/

<commit_msg>remove test commit from README<commit_after>Vcloud-tools guide
============

A collection of tools that support automation of VMWare VCloud Director

## [Vcloud Launch][vcloud-launch]
A tool that takes a YAML configuration file describing a vDC, and provisions
the vApps and VMs contained within.

## [Vcloud Walker][vcloudwalker]
A tool that reports on the current state of an environment

## [Configure edgegateway services][edgegateway]
Examples of fog usage to configure Edge Gateway Services

## [Tag search][tag_search]
A tool that will perform operations on a set of Vapps that match the given tags.

Required set-up
===============

VCloud-tools is based around [fog].

To use it you need a `.fog` file in your home directory.

For example:

    test:
      vcloud_director_username: 'username@org_name'
      vcloud_director_host: 'api.vcd.portal.skyscapecloud.com'
      vcloud_director_password: 'password'

Unfortunately current usage of fog requires the password in this file.

## Troubleshooting

To troubleshoot fog related issues, set environment variables DEBUG or EXCON_DEBUG.
For more details see: http://fog.io/about/getting_started.html#debugging.

## Testing

To run the unit tests: `bundle exec rake spec`

To run the integration tests: `bundle exec rake integration_test`.
You need access to an environment as the integration test actually spins up a
VM. The easiest thing to do is create a local shell script called
`vcloud_env.sh` and set the contents:

    export FOG\_CREDENTIAL=test
    export VCLOUD\_TEST\_VDC="Name of the VDC"
    export VCLOUD\_TEST\_CATALOG="catalog-name"
    export VCLOUD\_TEST\_TEMPLATE="name-of-template"

Then run this before you run the integration test.


[vcloudwalker]: https://github.com/alphagov/vcloud-walker
[edgegateway]: docs/edgegateway.md
[tag_search]: docs/tag_search.md
[vcloud-launch]: docs/vcloud-launch.md
[fog]: http://fog.io/

{'fraction_non_alphanumeric': 0.08927628103539356, 'fraction_numerical': 0.0, 'mean_word_length': 4.618694362017804, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1906505', 'n_tokens_mistral': 1161, 'n_tokens_neox': 1116, 'n_words': 432}