From 42b5ba3669bf7caf39e98f2d587651239c6dd5c4 Mon Sep 17 00:00:00 2001 From: Steve Axthelm Date: Tue, 9 Apr 2019 16:50:31 -0700 Subject: [PATCH] change urls in docs to use example.net/.com 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. --- README.md | 14 +++++++------- vmfloaty.yml.example | 4 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 486ee65..5526e42 100644 --- a/README.md +++ b/README.md @@ -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 ``` diff --git a/vmfloaty.yml.example b/vmfloaty.yml.example index fa6507f..d14388e 100644 --- a/vmfloaty.yml.example +++ b/vmfloaty.yml.example @@ -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'