From 4b438fcf751bf166cf5107fe1739097de58d08a6 Mon Sep 17 00:00:00 2001 From: Aaron Meihm Date: Mon, 10 Apr 2017 14:52:07 -0500 Subject: [PATCH] [doc] update loader documentation to reflect server side keygen --- doc/api.rst | 1 - doc/loader.rst | 18 ++++++++---------- 2 files changed, 8 insertions(+), 11 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 310b1467..6caf912e 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -954,7 +954,6 @@ POST /api/v1/loader/key/ * Description: Change loader key for a loader instance * Parameters: (POST body) - `loaderid`: ID of loader instance to modify - - `loaderkey`: New key for loader instance * Authentication: X-PGPAUTHORIZATION or X-MIGAPIKEY * Response Code: 200 OK * Response: Collection+JSON diff --git a/doc/loader.rst b/doc/loader.rst index d3a6898a..2b509c5a 100644 --- a/doc/loader.rst +++ b/doc/loader.rst @@ -323,22 +323,20 @@ and can use the ``setperms`` command if needed. Name: 'corbomite.internal' Provide expected environment target string, or enter for none expectenv> tags#>>'{operator}'='myorg' - Generating loader prefix... - Generating loader key... { "id": 0, "name": "corbomite.internal", - "prefix": "qqLwjje7", - "key": "BNbZUenzBaucYKgK6ubkz0yqDZ7k4kNX", + "prefix": "", + "key": "", "agentname": "", "lastseen": "0001-01-01T00:00:00Z", "enabled": false "expectenv": "tags#\u003e\u003e'{operator}'='myorg'" } - - Loader key including prefix to supply to client will be "qqLwjje7BNbZUenzBaucYKgK6ubkz0yqDZ7k4kNX" + Server will assign prefix and key on creation create loader entry? (y/n)> y - New entry successfully created but is disabled + Loader key including prefix to supply to client will be "qqLwjje7BNbZUenzBaucYKgK6ubkz0yqDZ7k4kNX" + New entry successfully created (id 12) but is disabled mig> The name can be any value you want, but usually you will want something describing @@ -349,9 +347,9 @@ If desired, an expected environment value can be set on the instance. If set, th must match desired parts of the environment the loader is sending, if it does not the request will be rejected. -The key including prefix is the API key that -will need to be configured in mig-loader on that system to allow it to authenticate as -this loader instance. +The key including prefix is the API key that will need to be configured in mig-loader that will +allow it to authenticate as this loader instance. This value is generated by the API when the +loader instance is created and can be changed later if needed. The new loader is created in a disabled state. Lets enable it so that it can be used.