docs: Add some meta tags to key docs

While playing with AZ documentation, I realized we were really lacking
on our SEO game. So, this is an attempt to augment our core docs in
a simple way, add metadata tags.

Specifically I asked claude to review and propose tags based upon
the content in each file it considered core documentation based
upon the structure and content.

Assisted-By: Claude Code - Claude Sonnet 4
Change-Id: I3efe42c50dd22e2c03d4e4bbf9746da18c9c6abb
Signed-off-by: Julia Kreger <juliaashleykreger@gmail.com>
This commit is contained in:
Julia Kreger
2025-09-24 10:28:17 -07:00
parent c539943c01
commit 686d289d5c
18 changed files with 124 additions and 3 deletions

View File

@@ -1,7 +1,9 @@
.. meta::
:keywords: availability zones, AZ, fault tolerance, conductor groups,
shards, resource partitioning, high availability, scaling,
multiple deployments, nova compute
:description: Implement availability zones with Ironic using conductor groups and shards. Multi-datacenter deployments, fault tolerance, and resource partitioning strategies.
:keywords: availability zones, conductor groups, shards, fault tolerance, multi-datacenter, resource partitioning, high availability, geographic distribution
:author: OpenStack Ironic Team
:robots: index, follow
:audience: cloud architects, system administrators
==========================================
Availability Zones and Resource Isolation

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Automated cleaning and preparation of bare metal nodes in Ironic. Security wiping, hardware configuration, and node lifecycle management.
:keywords: node cleaning, automated cleaning, security wiping, hardware preparation, node lifecycle, tenant isolation, data security
:author: OpenStack Ironic Team
:robots: index, follow
:audience: security engineers, system administrators
.. _cleaning:
=============

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Comprehensive guide to Ironic hardware drivers and interfaces. Configure support for IPMI, Redfish, vendor-specific management, and hardware types.
:keywords: ironic drivers, hardware interfaces, IPMI, redfish, hardware management, vendor drivers, boot interfaces, power management
:author: OpenStack Ironic Team
:robots: index, follow
:audience: system administrators, hardware engineers
===========================================================
Drivers, Hardware Types, and Hardware Interfaces for Ironic
===========================================================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Configure Ironic iLO driver for HPE ProLiant server management. Support for iLO 4, iLO 5, virtual media, and HPE-specific hardware features.
:keywords: ilo driver, hpe proliant, hpe servers, ilo4, ilo5, virtual media, hpe management, proliant automation
:author: OpenStack Ironic Team
:robots: index, follow
:audience: system administrators, hardware engineers
.. _ilo:
==========

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Configure Ironic IPMI driver using ipmitool for legacy server management. Power control, console access, and hardware monitoring via IPMI protocol.
:keywords: ipmi driver, ipmitool, legacy servers, power management, console access, hardware monitoring, baseboard management controller
:author: OpenStack Ironic Team
:robots: index, follow
:audience: system administrators, hardware engineers
===========
IPMI driver
===========

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Configure Ironic Redfish driver for modern server management. Support for Dell, HPE, Supermicro, and standards-based BMC control via Redfish API.
:keywords: redfish driver, BMC management, server automation, dell idrac, hpe ilo, supermicro, standards-based management, REST API
:author: OpenStack Ironic Team
:robots: index, follow
:audience: system administrators, hardware engineers
==============
Redfish driver
==============

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Ironic administrator guide for managing OpenStack bare metal infrastructure. Operation, configuration, drivers, networking, and troubleshooting for production deployments.
:keywords: ironic admin, bare metal administration, openstack infrastructure, ironic configuration, hardware drivers, network configuration, conductor management
:author: OpenStack Ironic Team
:robots: index, follow
:audience: system administrators, cloud operators, infrastructure engineers
Administrator's Guide
=====================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Configure networking for Ironic bare metal deployments. Neutron integration, VLAN management, physical networks, and tenant network isolation.
:keywords: ironic networking, neutron integration, bare metal networking, VLAN configuration, physical networks, tenant isolation, network interfaces
:author: OpenStack Ironic Team
:robots: index, follow
:audience: network engineers, system administrators
.. _admin-networking:
======================================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Configure RAID storage for Ironic bare metal nodes. Hardware RAID, software RAID, and automated storage configuration during deployment.
:keywords: raid configuration, hardware raid, software raid, storage configuration, disk management, ironic raid, automated setup
:author: OpenStack Ironic Team
:robots: index, follow
:audience: storage engineers, system administrators
.. _raid:
==================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Secure Ironic bare metal deployments. Authentication, authorization, secure boot, network security, and compliance considerations for production environments.
:keywords: ironic security, bare metal security, secure boot, authentication, authorization, network security, compliance, production security
:author: OpenStack Ironic Team
:robots: index, follow
:audience: security engineers, compliance officers
.. _security:
=================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Troubleshoot common Ironic bare metal service issues. Deployment failures, driver problems, network issues, and performance optimization solutions.
:keywords: ironic troubleshooting, bare metal issues, deployment failures, driver debugging, network problems, performance issues, error resolution
:author: OpenStack Ironic Team
:robots: index, follow
:audience: system administrators, support engineers
.. _troubleshooting:
======================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Performance tuning for Ironic bare metal service. Optimize conductor performance, database configuration, and large-scale deployment considerations.
:keywords: performance tuning, scalability, conductor performance, database optimization, large scale deployment, performance optimization
:author: OpenStack Ironic Team
:robots: index, follow
:audience: performance engineers, system administrators
=============
Tuning Ironic
=============

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Ironic REST API reference documentation. Complete API endpoints, request/response formats, authentication, and microversion support.
:keywords: ironic api, rest api, api reference, microversions, authentication, endpoints, bare metal api, openstack api
:author: OpenStack Ironic Team
:robots: index, follow
:audience: developers, api consumers
===============================
REST API Versioning for Ironic
===============================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Ironic OpenStack bare metal provisioning service documentation. Install, configure, and manage physical servers in cloud environments with comprehensive guides and API references.
:keywords: ironic, openstack, bare metal, physical servers, provisioning, cloud infrastructure, IPMI, PXE, hardware management
:author: OpenStack Ironic Team
:robots: index, follow
:canonical: https://docs.openstack.org/ironic/latest/
==================================
Welcome to Ironic's documentation!
==================================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Integrate Ironic with OpenStack Nova for bare metal instance management. Configure flavors, host aggregates, and bare metal scheduling.
:keywords: nova integration, bare metal instances, openstack compute, flavors configuration, host aggregates, scheduling, ironic nova driver
:author: OpenStack Ironic Team
:robots: index, follow
:audience: cloud operators, openstack administrators
Configure the Compute service to use the Bare Metal service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Complete installation guide for OpenStack Ironic bare metal service. Step-by-step setup, integration with OpenStack services, and deployment configurations.
:keywords: ironic installation, openstack installation, bare metal setup, ironic configuration, driver setup, service deployment
:author: OpenStack Ironic Team
:robots: index, follow
:audience: system administrators, cloud operators
=====================================
Bare Metal Service Installation Guide
=====================================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: Deploy bare metal instances with Ironic. Standalone deployments, allocations, boot modes, and direct provisioning without Nova integration.
:keywords: bare metal deployment, ironic standalone, instance deployment, allocations, boot modes, direct provisioning, metalsmith
:author: OpenStack Ironic Team
:robots: index, follow
:audience: cloud users, developers
Deploying with Bare Metal service
=================================

View File

@@ -1,3 +1,10 @@
.. meta::
:description: User guide for OpenStack Ironic bare metal service. Deploy physical servers, manage instances, and integrate with OpenStack cloud services.
:keywords: ironic user guide, bare metal instances, physical server deployment, openstack integration, metalsmith, instance management
:author: OpenStack Ironic Team
:robots: index, follow
:audience: cloud users, developers, operators
=============================
Bare Metal Service User Guide
=============================