Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc from openstack admin guide #1083

Open
wants to merge 21 commits into
base: stackhpc/2023.1
Choose a base branch
from

Conversation

seunghun1ee
Copy link
Member

@seunghun1ee seunghun1ee commented May 30, 2024

Moved general operation documentations from Openstack admin guide.
Removed customer specific templatings and tried to generalise.
Updated old contents

  • Update hardware inspection with Cardiff tool to ADVise tool
  • Remove Ceph-ansible section of Ceph management
  • Updated Nova client command to Openstack client commands

Please let me know if there are more contents that need to be updated.

Related PR on Openstack Admin Guide stackhpc/openstack-admin-guide#53

@seunghun1ee seunghun1ee self-assigned this May 30, 2024
@seunghun1ee seunghun1ee requested a review from a team as a code owner May 30, 2024 08:56
doc/source/operations/ceph-management.rst Show resolved Hide resolved
doc/source/operations/ceph-management.rst Outdated Show resolved Hide resolved
doc/source/operations/control-plane-operation.rst Outdated Show resolved Hide resolved
doc/source/operations/control-plane-operation.rst Outdated Show resolved Hide resolved
doc/source/operations/control-plane-operation.rst Outdated Show resolved Hide resolved
doc/source/operations/customising-horizon.rst Outdated Show resolved Hide resolved
doc/source/operations/customising-horizon.rst Outdated Show resolved Hide resolved
doc/source/operations/openstack-reconfiguration.rst Outdated Show resolved Hide resolved
doc/source/operations/wazuh-operation.rst Outdated Show resolved Hide resolved
@seunghun1ee seunghun1ee changed the title WIP: Doc from openstack admin guide Doc from openstack admin guide Jun 17, 2024
@seunghun1ee seunghun1ee force-pushed the doc-from-openstack-admin-guide branch from d9d7187 to 90a9b23 Compare June 17, 2024 14:29
@seunghun1ee seunghun1ee force-pushed the doc-from-openstack-admin-guide branch from 90a9b23 to ac2cafb Compare June 17, 2024 14:37
The short version
=================

#. Create an infrastructure VM for the Wazuh manager, and add it to the wazuh-manager group
#. Configure the infrastructure VM with kayobe: ``kayobe infra vm host configure``
#. Edit your config under
``etc/kayobe/inventory/group_vars/wazuh-manager/wazuh-manager``, in
``$KAYOBE_CONFIG_PATHinventory/group_vars/wazuh-manager/wazuh-manager``, in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
``$KAYOBE_CONFIG_PATHinventory/group_vars/wazuh-manager/wazuh-manager``, in
``$KAYOBE_CONFIG_PATH/inventory/group_vars/wazuh-manager/wazuh-manager``, in


Those groups are usually defined in ``etc/kayobe/inventory/groups``.

Running cephadm playbooks
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
Running cephadm playbooks
Running Cephadm playbooks

or

Suggested change
Running cephadm playbooks
Running ``cephadm`` playbooks

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for other uses of "cephadm"

Comment on lines +33 to +42
- ``cephadm.yml`` - runs the end to end process starting with deployment and
defining EC profiles/crush rules/pools and users
- ``cephadm-crush-rules.yml`` - defines Ceph crush rules according
- ``cephadm-deploy.yml`` - runs the bootstrap/deploy playbook without the
additional playbooks
- ``cephadm-ec-profiles.yml`` - defines Ceph EC profiles
- ``cephadm-gather-keys.yml`` - gather Ceph configuration and keys and populate
kayobe-config
- ``cephadm-keys.yml`` - defines Ceph users/keys
- ``cephadm-pools.yml`` - defines Ceph pools\
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order here has changed a bit since this was written, and there are some new playbooks that run custom commands. The list is here: https://github.com/stackhpc/stackhpc-kayobe-config/blob/stackhpc/2023.1/etc/kayobe/ansible/cephadm.yml

- ``cephadm-keys.yml`` - defines Ceph users/keys
- ``cephadm-pools.yml`` - defines Ceph pools\

Running Ceph commands
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should get someone with more Ceph experience to review the rest of this file to check it for accuracy.

----------

* `Back up InfluxDB <https://docs.influxdata.com/influxdb/v1.8/administration/backup_and_restore/>`__
* `Back up ElasticSearch <https://www.elastic.co/guide/en/elasticsearch/reference/current/backup-cluster-data.html>`__
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `Back up ElasticSearch <https://www.elastic.co/guide/en/elasticsearch/reference/current/backup-cluster-data.html>`__
* `Back up OpenSearch <https://opensearch.org/docs/latest/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/>`__


.. code-block:: console

monitoring0# for i in `docker ps -q`; do docker stop $i; done
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should use systemctl rather than docker

Comment on lines +345 to +358
Upgrading OpenStack Services
----------------------------

* Update tags for the images in ``etc/kayobe/kolla-image-tags.yml``
* Pull container images to overcloud hosts with ``kayobe overcloud container image pull``
* Run ``kayobe overcloud service upgrade``

You can update the subset of containers or hosts by

.. code-block:: console

kayobe# kayobe overcloud service upgrade --kolla-tags <service> --limit <hostname> --kolla-limit <hostname>

For more information, see: https://docs.openstack.org/kayobe/latest/upgrading.html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd probably just delete this section. Full version upgrades require a lot more than this. For container tag bumps, we just use service deploy. Either way, I don't think this section is really that useful


.. code-block:: console

openstack server create --flavor <flavour name>--network <network name> --key-name <key> --image <Image name> --os-compute-api-version 2.74 --host <hypervisor hostname> <vm name>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
openstack server create --flavor <flavour name>--network <network name> --key-name <key> --image <Image name> --os-compute-api-version 2.74 --host <hypervisor hostname> <vm name>
openstack server create --flavor <flavour name> --network <network name> --key-name <key> --image <Image name> --os-compute-api-version 2.74 --host <hypervisor hostname> <vm name>


openstack server create --flavor <flavour name>--network <network name> --key-name <key> --image <Image name> --os-compute-api-version 2.74 --host <hypervisor hostname> <vm name>

Cleanup Procedures
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Patch merged and backported long ago. This can be removed

Comment on lines +116 to +117
It can be resolved by dropping cached content with ``docker restart
memcached``. Note this will log out users from Horizon, as Django sessions are
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It can be resolved by dropping cached content with ``docker restart
memcached``. Note this will log out users from Horizon, as Django sessions are
It can be resolved by dropping cached content with ``systemctl restart
kolla-memcached-container.service``. Note this will log out users from Horizon, as Django sessions are

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants