add documentation links

src/cli_encryption_key/encryption_config.js

@@ -32,6 +32,23 @@ export class EncryptionConfig {
     'xpack.reporting.encryptionKey',
     'xpack.security.encryptionKey',
   ];
+  #encryptionMeta = {
+    'xpack.encryptedSavedObjects.encryptionKey': {
+      docs:
+        'https://www.elastic.co/guide/en/kibana/current/xpack-security-secure-saved-objects.html#xpack-security-secure-saved-objects',
+      description: 'Used to encrypt stored objects such as dashboards and visualizations',
+    },
+    'xpack.reporting.encryptionKey': {
+      docs:
+        'https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#security-session-and-cookie-settings',
+      description: 'Used to encrypt saved reports',
+    },
+    'xpack.security.encryptionKey': {
+      docs:
+        'https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#security-session-and-cookie-settings',
+      description: 'Used to encrypt session information',
+    },
+  };
 
   _getEncryptionKey(key) {
     return get(this.#config, key);
@@ -45,6 +62,17 @@ export class EncryptionConfig {
     return crypto.randomBytes(16).toString('hex');
   }
 
+  docs() {
+    let docs = '';
+    this.#encryptionKeyPaths.forEach((key) => {
+      docs += `${key}
+    ${this.#encryptionMeta[key].description}
+    ${this.#encryptionMeta[key].docs}
+`;
+    });
+    return docs;
+  }
+
   generate({ force = false }) {
     const output = {};
     this.#encryptionKeyPaths.forEach((key) => {

src/cli_encryption_key/generate.js

@@ -28,16 +28,24 @@ export async function generate(encryptionConfig, command) {
   if (isEmpty(keys)) {
     logger.log('No keys to write.  Use the --force flag to generate new keys.');
   } else {
+    if (!command.quiet) {
+      logger.log('## Kibana Encryption Key Generation Utility\n');
+      logger.log(
+        `The 'generate' command guides you through the process of setting encryption keys for: `
+      );
+      logger.log(encryptionConfig.docs());
+      logger.log(
+        'Already defined settings are ignored and can be regenerated using the --force flag.  Check the documentation links for instructions on how to rotate encryption keys.'
+      );
+      logger.log('Definitions should be set in the kibana.yml used configure Kibana.\n');
+    }
     if (command.interactive) {
       await interactive(keys, logger);
     } else {
-      if (!command.quiet) logger.log('Generating encryption keys.');
+      if (!command.quiet) logger.log('Settings:');
       logger.log(safeDump(keys));
     }
   }
-  if (command.force && !command.quiet) {
-    logger.log('Any pre-existing keys in kibana.yml will need to be rotated manually.');
-  }
 }
 
 export function generateCli(program, encryptionConfig) {

src/cli_encryption_key/generate.test.js

@@ -35,8 +35,7 @@ describe('encryption key generation', () => {
       quiet: false,
     };
     generate(encryptionConfig, command);
-    const keys = Logger.prototype.log.mock.calls[1][0];
-
+    const keys = Logger.prototype.log.mock.calls[6][0];
     expect(keys.search('xpack.encryptedSavedObjects.encryptionKey')).toBeGreaterThanOrEqual(0);
     expect(keys.search('xpack.reporting.encryptionKey')).toBeGreaterThanOrEqual(0);
     expect(keys.search('xpack.security.encryptionKey')).toBeGreaterThanOrEqual(0);
@@ -51,18 +50,6 @@ describe('encryption key generation', () => {
     expect(nextLog).toEqual(undefined);
   });
 
-  it('should add a rotation warning if the force flag is set', () => {
-    generate(encryptionConfig, { force: true });
-    expect(Logger.prototype.log.mock.calls[2][0]).toEqual(
-      'Any pre-existing keys in kibana.yml will need to be rotated manually.'
-    );
-  });
-
-  it('should not add a rotation warning if the force flag is unset', () => {
-    generate(encryptionConfig, { force: false });
-    expect(Logger.prototype.log.mock.calls[2]).toBeUndefined();
-  });
-
   afterEach(() => {
     jest.restoreAllMocks();
   });

src/cli_encryption_key/interactive.js

@@ -24,12 +24,6 @@ import { safeDump } from 'js-yaml';
 
 export async function interactive(keys, logger) {
   const settings = Object.keys(keys);
-  logger.log('## Kibana Encryption Key Generation Utility\n');
-  logger.log(
-    `The 'generate' command guides you through the process of generating encryption keys for: `
-  );
-  logger.log(settings.join('\n'));
-  logger.log('');
   logger.log(
     'This tool will ask you a number of questions in order to generate the right set of keys for your needs.\n'
   );