From 05ff55e250d5a9735b58efe3b00ec198ec0ecbec Mon Sep 17 00:00:00 2001 From: Colleen Murphy Date: Wed, 12 Dec 2018 11:33:12 +0100 Subject: [PATCH] Remove example usage from admin guide It's redundant with the supported clients docs[1] and the managing projects users and roles docs[2]. [1] https://docs.openstack.org/keystone/latest/user/supported_clients.html [2] https://docs.openstack.org/keystone/latest/admin/cli-manage-projects-users-and-roles.html Change-Id: I8549e4e7123d719fadfbfeddf20781e90ccb541c --- doc/source/admin/index.rst | 2 +- .../admin/keystone-usage-and-features.rst | 50 ------------------- doc/source/admin/logging.rst | 15 ++++++ 3 files changed, 16 insertions(+), 51 deletions(-) delete mode 100644 doc/source/admin/keystone-usage-and-features.rst create mode 100644 doc/source/admin/logging.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst index 213e98eb9d..43cfb1693c 100644 --- a/doc/source/admin/index.rst +++ b/doc/source/admin/index.rst @@ -30,7 +30,6 @@ command-line client. security-compliance.rst resource-options.rst performance.rst - keystone-usage-and-features.rst auth-token-middleware.rst service-api-protection.rst troubleshoot.rst @@ -47,6 +46,7 @@ command-line client. external-authentication.rst configure_tokenless_x509.rst limit-list-size.rst + logging.rst .. toctree:: :maxdepth: 2 diff --git a/doc/source/admin/keystone-usage-and-features.rst b/doc/source/admin/keystone-usage-and-features.rst deleted file mode 100644 index ade44151f9..0000000000 --- a/doc/source/admin/keystone-usage-and-features.rst +++ /dev/null @@ -1,50 +0,0 @@ - -Example usage and Identity features -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The ``openstack`` CLI is used to interact with the Identity service. -It is set up to expect commands in the general -form of ``openstack command argument``, followed by flag-like keyword -arguments to provide additional (often optional) information. For -example, the :command:`openstack user list` and -:command:`openstack project create` commands can be invoked as follows: - -.. code-block:: bash - - # Using token auth env variables - export OS_TOKEN=secret - export OS_URL=http://127.0.0.1:5000/v3/ - openstack user list - openstack project create demo --domain default - - # Using token auth flags - openstack --os-token secret --os-url http://127.0.0.1:5000/v3/ user list - openstack --os-token secret --os-url http://127.0.0.1:5000/v3/ project create demo - - # Using user + password + project_name env variables - export OS_USERNAME=admin - export OS_PASSWORD=secret - export OS_PROJECT_NAME=admin - openstack user list - openstack project create demo --domain default - - # Using user + password + project-name flags - openstack --os-username admin --os-password secret --os-project-name admin user list - openstack --os-username admin --os-password secret --os-project-name admin project create demo - - -Logging -------- - -You configure logging externally to the rest of Identity. The name of -the file specifying the logging configuration is set using the -``log_config_append`` option in the ``[DEFAULT]`` section of the -``/etc/keystone/keystone.conf`` file. To route logging through syslog, -set ``use_syslog=true`` in the ``[DEFAULT]`` section. - -A sample logging configuration file is available with the project in -``etc/logging.conf.sample``. Like other OpenStack projects, Identity -uses the `Python logging module`_, which provides extensive configuration -options that let you define the output levels and formats. - -.. _`Python logging module`: https://docs.python.org/library/logging.html diff --git a/doc/source/admin/logging.rst b/doc/source/admin/logging.rst new file mode 100644 index 0000000000..c8a126e957 --- /dev/null +++ b/doc/source/admin/logging.rst @@ -0,0 +1,15 @@ +Logging +------- + +You configure logging externally to the rest of Identity. The name of +the file specifying the logging configuration is set using the +``log_config_append`` option in the ``[DEFAULT]`` section of the +``/etc/keystone/keystone.conf`` file. To route logging through syslog, +set ``use_syslog=true`` in the ``[DEFAULT]`` section. + +A sample logging configuration file is available with the project in +``etc/logging.conf.sample``. Like other OpenStack projects, Identity +uses the `Python logging module`_, which provides extensive configuration +options that let you define the output levels and formats. + +.. _`Python logging module`: https://docs.python.org/library/logging.html