puppetlabs/vmfloaty
2
0
Fork 0
mirror of https://github.com/puppetlabs/vmfloaty.git synced 2026-01-25 21:28:40 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

change urls in docs to use example.net/.com

Browse source 
Prior to this commit, the docs and vmfloaty.yml.example file used
a variety of live domains (mycompany.net, alternate.net). This commit
changes those to example.net and example.com which are IANA-managed
Reserved Domains. This will reduce the chance that any credentials
could be harvested if a user executes the example commands without
changing the domains.
This commit is contained in:
Steve Axthelm 2019-04-09 16:50:31 -07:00
parent d57b168153
commit 42b5ba3669
2 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -53,7 +53,7 @@ $ floaty --help
Grabbing a token for authenticated pooler requests:
```
floaty token get --user username --url https://vmpooler.mycompany.net/api/v1
floaty token get --user username --url https://vmpooler.example.net/api/v1
```
This command will then ask you to log in. If successful, it will return a token that you can save either in a dotfile or use with other cli commands.
@ -61,7 +61,7 @@ This command will then ask you to log in. If successful, it will return a token
Grabbing vms:
```
floaty get centos-7-x86_64=2 debian-7-x86_64 windows-10=3 --token mytokenstring --url https://vmpooler.mycompany.net/api/v1
floaty get centos-7-x86_64=2 debian-7-x86_64 windows-10=3 --token mytokenstring --url https://vmpooler.example.net/api/v1
```
### vmfloaty dotfile
@ -72,7 +72,7 @@ If you do not wish to continuely specify various config options with the cli, yo
```yaml
# file at /Users/me/.vmfloaty.yml
url: 'https://vmpooler.mycompany.net/api/v1'
url: 'https://vmpooler.example.net/api/v1'
user: 'brian'
token: 'tokenstring'
```
@ -90,10 +90,10 @@ To configure multiple services, you can set up your `~/.vmfloaty.yml` config fil
user: 'brian'
services:
main:
url: 'https://vmpooler.mycompany.net/api/v1'
url: 'https://vmpooler.example.net/api/v1'
token: 'tokenstring'
alternate:
url: 'https://vmpooler.alternate.net/api/v1'
url: 'https://vmpooler.example.com/api/v1'
token: 'alternate-tokenstring'
```
@ -125,10 +125,10 @@ vmfloaty is capable of working with Puppet's [nonstandard pooler](https://github
user: 'brian'
services:
vm:
url: 'https://vmpooler.mycompany.net/api/v1'
url: 'https://vmpooler.example.net/api/v1'
token: 'tokenstring'
ns:
url: 'https://nspooler.mycompany.net/api/v1'
url: 'https://nspooler.example.net/api/v1'
token: 'nspooler-tokenstring'
type: 'nonstandard' # <-- 'type' is necessary for any non-vmpooler service
```

4
vmfloaty.yml.example
View file

@ -1,8 +1,8 @@
user: 'brian'
services:
main:
url: 'https://vmpooler.mycompany.net/api/v1'
url: 'https://vmpooler.example.net/api/v1'
token: 'tokenstring'
alternate:
url: 'https://vmpooler.alternate.net/api/v1'
url: 'https://vmpooler.example.com/api/v1'
token: 'alternate-tokenstring'