_topic_map.yml

# This configuration file dictates the organization of the topic groups and
# topics on the main page of the doc site for this branch. Each record
# consists of the following:
#
# ---                                 <= Record delimiter
# Name: Origin of the Species         <= Display name of topic group
# Dir:  origin_of_the_species         <= Directory name of topic group
# Topics:
#   - Name: The Majestic Marmoset     <= Topic name
#     File: the_majestic_marmoset     <= Topic file under group dir +/- .adoc
#   - Name: The Curious Crocodile     <= Topic 2 name
#     File: the_curious_crocodile     <= Topic 2 file
#
# The ordering of the records in this document determines the ordering of the
# topic groups and topics on the main page.
---
Name: ManageIQ Documentation
Dir: welcome
Topics:
  - Name: Welcome
    File: index

---
Name: Authentication
Dir: auth
Topics:
  - Name: Configuring External Authentication with Active Directory
    File: active_directory
  - Name: Configuring External Authentication with LDAP
    File: ldap
  - Name: External Authentication using 2-Factor-Authentication with IPA
    File: ipa_2fa
  - Name: External Authentication with IPA/AD Trust
    File: ipa_ad_trust
  - Name: Configuring External Authentication with SAML
    File: saml
  - Name: Configuring External Authentication with OpenID-Connect
    File: openid_connect

---
Name: REST API
Dir: api
Topics:
  - Name: Overview
    Dir: overview
    Topics:
      - Name: Authentication
        File: auth
      - Name: Authorization
        File: authorization
      - Name: Password Updates
        File: password
      - Name: CRUD
        File: crud
      - Name: HTTP Basics
        File: http
      - Name: Json Convention
        File: json
      - Name: Querying
        File: query
      - Name: Bulk Querying
        File: bulk_query
      - Name: Filtering
        File: filtering
      - Name: Pagination
        File: pagination
      - Name: Usage Examples
        File: usage_examples
      - Name: Version History
        File: versioning
  - Name: Reference
    Dir: reference
    Topics:
      - Name: Primary Collections
        File: collections
      - Name: Actions
        File: actions
      - Name: Alert Management
        File: alerts
      - Name: Authentication Management
        File: authentications
      - Name: Automate Model
        File: automate
      - Name: Automate Domains
        File: automate_domains
      - Name: Automation Requests
        File: automation_requests
      - Name: Automate Workspaces
        File: automate_workspaces
      - Name: "Categories & Tags"
        File: categories_tags
      - Name: "Chargebacks & Rates"
        File: chargebacks_rates
      - Name: Cloud Volumes
        File: cloud_volumes
      - Name: Conditions
        File: conditions
      - Name: Configuration Script Source Management
        File: configuration_script_sources
      - Name: Conversion hosts
        File: conversion_hosts
      - Name: Custom Actions
        File: custom_actions
      - Name: Custom Attributes
        File: custom_attributes
      - Name: Custom Button Management
        File: custom_buttons
      - Name: Event Streams
        File: event_streams
      - Name: Flavor Management
        File: flavors
      - Name: Generic Object Management
        File: generic_objects
      - Name: Group Management
        File: groups
      - Name: Host Management
        File: hosts
      - Name: Instance Management
        File: instances
      - Name: Metric Rollups
        File: metric_rollups
      - Name: Network Routers
        File: network_routers
      - Name: Notifications Support
        File: notifications
      - Name: Orchestration Support
        File: orchestration
      - Name: Physical Servers
        File: physical_servers
      - Name: Picture Management
        File: pictures
      - Name: "Policies & Policy Profiles"
        File: policies
      - Name: Policy Collections
        File: policy_collections
      - Name: Provider Support
        File: providers
      - Name: Provision Requests
        File: provision_requests
      - Name: Request Support
        File: requests
      - Name: Reports Support
        File: reports
      - Name: Role Management
        File: roles
      - Name: Security Groups
        File: security_groups
      - Name: Service Management
        File: services
      - Name: Service Queries
        File: service_queries
      - Name: Service Custom Actions
        File: service_custom_actions
      - Name: Service Dialogs
        File: service_dialogs
      - Name: Service Orders (Shopping Carts)
        File: service_orders
      - Name: Setting Ownership
        File: ownership
      - Name: Settings Management
        File: settings
      - Name: Snapshot Management
        File: snapshots
      - Name: "Tags & Tagging"
        File: tagging
      - Name: Tasks
        File: tasks
      - Name: Tenant Management
        File: tenants
      - Name: Transformation Mappings
        File: transformation_mappings
      - Name: User Management
        File: users
      - Name: VM Management
        File: vms
  - Name: Appendices
    Dir: appendices
    Topics:
      - Name: Quick Reference
        File: quick_reference
      - Name: Collection Metadata
        File: collection_metadata
      - Name: Resource Attributes
        File: resource_attributes
      - Name: Provider Types
        File: provider_types
      - Name: Provision Request Supported Attributes
        File: provision_attributes
      - Name: Advanced Provisioning Attributes
        File: advanced_provisioning
      - Name: SOAP to REST Mapping
        File: soap_to_rest
      - Name: Deprecated Types
        File: deprecated_types
      - Name: Deprecated Resource Attributes
        File: deprecated_resource_attributes

---
Name: REST API Examples
Dir: api
Topics:
  - Name: Foundation
    Dir: examples
    Topics:
      - Name: Querying Examples
        File: queries
      - Name: Paging Queries
        File: paging_queries
  - Name: Automation Requests
    Dir: examples
    Topics:
      - Name: Create an Automation Request
        File: automation_request
      - Name: Create multiple Automation Requests
        File: automation_requests
  - Name: Providers
    Dir: examples
    Topics:
      - Name: Create a Provider
        File: create_provider
      - Name: Create a Provider with multiple credentials
        File: create_provider_compound_credentials
      - Name: Update a Provider
        File: update_provider
      - Name: Refresh Provider
        File: refresh_provider
      - Name: Delete Provider
        File: delete_provider
  - Name: Provisioning Requests
    Dir: examples
    Topics:
      - Name: Create a Provision Request
        File: provision_request
      - Name: Create multliple Provision Requests
        File: provision_requests
  - Name: Service Catalogs
    Dir: examples
    Topics:
      - Name: Add a Service Catalog
        File: add_service_catalog
      - Name: Add multiple Service Catalogs
        File: add_service_catalogs
      - Name: Edit a Service Catalog
        File: edit_service_catalog
      - Name: Edit Service Catalogs
        File: edit_service_catalogs
      - Name: Assign Service Templates
        File: assign_service_templates
      - Name: Unassign Service Templates
        File: unassign_service_templates
      - Name: Delete Service Catalogs
        File: delete_service_catalogs
  - Name: Service Templates
    Dir: examples
    Topics:
      - Name: Edit a Service Template
        File: edit_service_template
      - Name: Edit Service Templates
        File: edit_service_templates
      - Name: Delete Service Templates
        File: delete_service_templates
  - Name: Services
    Dir: examples
    Topics:
      - Name: Order a Service
        File: order_service
      - Name: Order multiple Services
        File: order_services
      - Name: Edit a Service
        File: edit_service
      - Name: Edit Service via PATCH
        File: edit_service_via_patch
      - Name: Edit Service via PUT
        File: edit_service_via_put
      - Name: Edit Services
        File: edit_services
      - Name: Reconfigure Service
        File: reconfigure_service
      - Name: Refresh Service Template Dialog Fields
        File: refresh_dialog_fields
      - Name: Refresh Service Dialog Fields
        File: refresh_service_dialog_fields
      - Name: Retire a Service
        File: retire_service
      - Name: Retire multiple Services
        File: retire_services
      - Name: Trigger a Custom Action on a Service
        File: custom_action_service
      - Name: Delete Services
        File: delete_services
  - Name: VM Management
    Dir: examples
    Topics:
      - Name: Start a VM
        File: start_vm
      - Name: Stop a VM
        File: stop_vm
      - Name: Suspend a VM
        File: suspend_vm
      - Name: Scan a VM
        File: scan_vm
      - Name: Set owner of a VM
        File: set_owner_vm
      - Name: Add event to a VM
        File: add_event_vm
      - Name: Add lifecycle event to a VM
        File: add_lifecycle_event_vm
      - Name: Delete a VM
        File: delete_vm
  - Name: Tag Management
    Dir: examples
    Topics:
      - Name: Assign Tags
        File: assign_tags
      - Name: Assign Tags to Service Template
        File: assign_tags_to_service_template
      - Name: Unassign Tags
        File: unassign_tags
      - Name: Unassign Tags from a Service Template
        File: unassign_tags_from_service_template
  - Name: Usage Flows
    Dir: examples
    Topics:
      - Name: Compliance Policy Flow
        File: compliance_policy_flow
---
Name: Installing ManageIQ on Google Compute Engine
Dir: doc-Installing_on_Google_Compute_Engine
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Installing ManageIQ on Microsoft Azure
Dir: doc-Installing_on_Microsoft_Azure
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Installing ManageIQ on Amazon Web Services (AWS)
Dir: doc-Installing_on_AWS
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Installing ManageIQ on Red Hat Enterprise Linux OpenStack Platform
Dir: doc-Installing_on_Red_Hat_Enterprise_Linux_OpenStack_Platform
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Installing ManageIQ on VMware vSphere
Dir: doc-Installing_on_VMware_vSphere
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Installing ManageIQ on Microsoft SCVMM
Dir: doc-Installing_on_SCVMM
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Installing ManageIQ on Red Hat Virtualization
Dir: doc-Installing_on_Red_Hat_Virtualization
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: General Configuration
Dir: doc-General_Configuration
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Deployment Planning Guide
Dir: doc-Deployment_Planning_Guide
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Appliance Hardening Guide
Dir: doc-Appliance_Hardening_Guide
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: High Availability Guide
Dir: doc-High_Availability_Guide
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Integration with AWS CloudFormation and OpenStack Heat
Dir: doc-Integration_with_AWS_CloudFormation_and_OpenStack_Heat
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Integration with ServiceNow
Dir: doc-Integration_with_ServiceNow
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Self Service User Interface Guide
Dir: doc-Self_Service_User_Interface_Guide
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Managing Infrastructure and Inventory
Dir: doc-Managing_Infrastructure_and_Inventory
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Managing Providers
Dir: doc-Managing_Providers
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Methods Available for Automation
Dir: doc-Methods_Available_for_Automation
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Monitoring, Alerts, and Reporting
Dir: doc-Monitoring_Alerts_and_Reporting
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Policies and Profiles Guide
Dir: doc-Policies_and_Profiles_Guide
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Provisioning Virtual Machines and Hosts
Dir: doc-Provisioning_Virtual_Machines_and_Hosts
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: ManageIQ REST API
Dir: doc-REST_API
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index
---
Name: Scripting Actions in ManageIQ
Dir: doc-Scripting_Actions
Topics:
  - Name: Table of Contents
    Dir: miq
    Topics:
    - Name: Index
      File: index