From 570f45824c54e23b5b49e32fbbb04d59a4d0f5ea Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 12 Aug 2024 13:08:26 -0400 Subject: [PATCH 01/25] Minor updates --- _includes/configuration-db-external.md | 8 ++++---- _includes/configuration-db-internal.md | 7 +------ _includes/configuration.md | 10 ++-------- _includes/initial-login-changepw.md | 3 +-- _includes/initial-login.md | 3 +-- 5 files changed, 9 insertions(+), 22 deletions(-) diff --git a/_includes/configuration-db-external.md b/_includes/configuration-db-external.md index 7fad177a4..fa7da2a8c 100644 --- a/_includes/configuration-db-external.md +++ b/_includes/configuration-db-external.md @@ -24,11 +24,11 @@ necessary to alter the `max_connections` setting. **Note:** - - {{ site.data.product.title_short }} requires PostgreSQL version 13. + - {{ site.data.product.title_short }} requires PostgreSQL version 13. - - `postgresql.conf` controls the operation of all databases managed by the - PostgreSQL instance, therefore it is not recommended to run other databases - on this PostgreSQL instance. + - `postgresql.conf` controls the operation of all databases managed by the PostgreSQL instance, therefore it is not recommended to run other databases on this PostgreSQL instance. + +Use the following steps to configure an external PostgreSQL database: 1. Start the appliance and open a terminal console. diff --git a/_includes/configuration-db-internal.md b/_includes/configuration-db-internal.md index c613ee254..d58701d44 100644 --- a/_includes/configuration-db-internal.md +++ b/_includes/configuration-db-internal.md @@ -8,8 +8,6 @@ recommends adding the disk before starting the appliance. {{ site.data.product.title_short }} only supports installing of an internal VMDB on blank disks; installation will fail if the disks are not blank. - - 1. Start the appliance and open a terminal console. 2. Enter the `appliance_console` command. The {{ site.data.product.title_short }} appliance @@ -29,10 +27,7 @@ disks; installation will fail if the disks are not blank. first appliance. For worker and multi-region setups, use this option to copy key from another appliance. - **Note:** - - All {{ site.data.product.title_short }} appliances in a multi-region - deployment must use the same key. + **Note**: All {{ site.data.product.title_short }} appliances in a multi-region deployment must use the same key. 6. Choose **Create Internal Database** for the database location. diff --git a/_includes/configuration.md b/_includes/configuration.md index 149931dc3..4ddb7ce34 100644 --- a/_includes/configuration.md +++ b/_includes/configuration.md @@ -27,10 +27,7 @@ Configure the appliance by using the internal appliance console. 6. Press `Enter` to accept a setting where applicable. -**Note:** - -The {{ site.data.product.title_short }} appliance console automatically logs out -after five minutes of inactivity. +**Note**: The {{ site.data.product.title_short }} appliance console automatically logs out after five minutes of inactivity. ### Configuring a Database @@ -80,10 +77,7 @@ has a region configured with a database and messaging. remote machine**. For worker and multi-region setups, use this option to copy the security key from another appliance. - **Note:** - - All {{ site.data.product.title_short }} appliances in a multi-region deployment - must use the same key. + **Note**: All {{ site.data.product.title_short }} appliances in a multi-region deployment must use the same key. 6. Choose **Join Region in External Database** for the database location. diff --git a/_includes/initial-login-changepw.md b/_includes/initial-login-changepw.md index ab9f938b0..54a9ca452 100644 --- a/_includes/initial-login-changepw.md +++ b/_includes/initial-login-changepw.md @@ -1,8 +1,7 @@ Change your password to ensure more private and secure access to {{ site.data.product.title_short }}. -1. Browse to the URL for the login screen. ( on - the virtual machine instance) +1. Browse to the URL for the login screen. 2. Click **Update Password** beneath the **Username** and **Password** text fields. diff --git a/_includes/initial-login.md b/_includes/initial-login.md index 5c394cf7b..dfbe32b84 100644 --- a/_includes/initial-login.md +++ b/_includes/initial-login.md @@ -3,8 +3,7 @@ administration tasks. Log in to {{ site.data.product.title_short }} for the first time after installing by: -1. Browse to the URL for the login screen. ( on - the virtual machine instance) +1. Browse to the URL for the login screen. 2. Enter the default credentials (Username: **admin** | Password: **smartvm**) for the initial login. From 33ecbb4123e1efe7de15f452c0bd9c48e2cf16c9 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 12 Aug 2024 13:25:46 -0400 Subject: [PATCH 02/25] Update initial-login.md --- _includes/initial-login.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/_includes/initial-login.md b/_includes/initial-login.md index dfbe32b84..d2d5d6ba5 100644 --- a/_includes/initial-login.md +++ b/_includes/initial-login.md @@ -1,11 +1,10 @@ Once {{ site.data.product.title_short }} is installed, you can log in and perform administration tasks. -Log in to {{ site.data.product.title_short }} for the first time after installing by: - 1. Browse to the URL for the login screen. -2. Enter the default credentials (Username: **admin** | Password: - **smartvm**) for the initial login. +2. Enter the default credentials as listed for the initial login. + - **Username**: **admin** + - **Password**: **smartvm** 3. Click **Login**. From 0904fd9491d12670ca3af20dfbf1e97c5e39ec19 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 12 Aug 2024 13:30:47 -0400 Subject: [PATCH 03/25] Update configuration.md --- _includes/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/configuration.md b/_includes/configuration.md index 4ddb7ce34..50d48c454 100644 --- a/_includes/configuration.md +++ b/_includes/configuration.md @@ -37,7 +37,7 @@ Configure the appliance by using the internal appliance console. Configuring messaging is required for appliance setup. It is recommended to configure the broker on the same appliance where your database is configured -**Note:** You can only have one kafka broker per region +**Note:** You can only have one kafka broker per region. 1. You can either configure the current appliance as a kafka broker, or point the appliance to an existing external kafka broker. @@ -51,7 +51,7 @@ Configuring messaging is required for appliance setup. It is recommended to conf 2. Select **Proceed** and appliance_console will apply the configuration that you have requested then restart evmserverd to pick up the changes. -**Note:** It is recommended to use your Fully Qualified Domain Name (FQDN) as the messaging hostname rather than `localhost`, ensure that a resolvable and reachable non-localhost name entry is present in `/etc/hosts` +**Note:** It is recommended to use your Fully Qualified Domain Name (FQDN) as the messaging hostname rather than `localhost`, ensure that a resolvable and reachable non-localhost name entry is present in `/etc/hosts`. ### Configuring a Worker Appliance From 40160bc233c7b0c96ea3f7c95f37c612d1fb31f9 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 12 Aug 2024 13:41:15 -0400 Subject: [PATCH 04/25] Minor corrections/improvements --- _includes/configuration-db-external.md | 10 +++++----- _includes/configuration.md | 21 +++++++++++---------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/_includes/configuration-db-external.md b/_includes/configuration-db-external.md index fa7da2a8c..c6c490533 100644 --- a/_includes/configuration-db-external.md +++ b/_includes/configuration-db-external.md @@ -1,7 +1,7 @@ #### Configuring an External Database -Based on your setup, you will choose to configure the appliance to use -an external PostgreSQL database. For example, we can only have one +Based on your setup, you need to configure the appliance to use +an external PostgreSQL database. For example, you can only have one database in a single region. However, a region can be segmented into multiple zones, such as database zone, user interface zone, and reporting zone, where each zone provides a specific function. The @@ -19,7 +19,7 @@ Ensure you configure the settings in the `postgresql.conf` to suit your system. For example, customize the `shared_buffers` setting according to the amount of real storage available in the external system hosting the PostgreSQL instance. In addition, depending on the aggregate number of -appliances expected to connect to the PostgreSQL instance, it may be +appliances that are expected to connect to the PostgreSQL instance, it might be necessary to alter the `max_connections` setting. **Note:** @@ -32,7 +32,7 @@ Use the following steps to configure an external PostgreSQL database: 1. Start the appliance and open a terminal console. -2. Enter the `appliance_console` command. The appliance console summary screen will be displayed. +2. Enter the `appliance_console` command. The appliance console summary screen is displayed. 3. Press **Enter** to manually configure settings. @@ -51,4 +51,4 @@ Use the following steps to configure an external PostgreSQL database: 10. Confirm the configuration if prompted. -{{ site.data.product.title_short }} will then configure the external database. +{{ site.data.product.title_short }} configures an external database. diff --git a/_includes/configuration.md b/_includes/configuration.md index 50d48c454..a0b15a31c 100644 --- a/_includes/configuration.md +++ b/_includes/configuration.md @@ -20,7 +20,7 @@ Configure the appliance by using the internal appliance console. 3. Press `Enter` to manually configure settings. -4. Press the number for the item you want to change, and press `Enter`. +4. Press the number for the item that you want to change, and press `Enter`. The options for your selection are displayed. 5. Follow the prompts to make the changes. @@ -35,23 +35,24 @@ Configure the appliance by using the internal appliance console. ### Configure Messaging -Configuring messaging is required for appliance setup. It is recommended to configure the broker on the same appliance where your database is configured +Configuring messaging is required for the appliance setup. It is recommended to configure the broker on the same appliance where your database is configured -**Note:** You can only have one kafka broker per region. +**Note:** You can only have one Kafka broker per region. -1. You can either configure the current appliance as a kafka broker, or point the - appliance to an existing external kafka broker. +1. You can either configure the current appliance as a Kafka broker, or point the + appliance to an existing external Kafka broker. Select the appropriate option either **Configure this appliance as a messaging server** or **Connect to an external messaging system** - to connect to an external kafka broker. You will be asked to fill in the - required **Message Client Parameters** like IP address and username/password. + to connect to an external Kafka broker. Fill in the + required **Message Client Parameters**, such as IP address, username and password. -2. Select **Proceed** and appliance_console will apply the configuration that you have - requested then restart evmserverd to pick up the changes. +2. Select **Proceed**. `appliance_console` applies the configuration that you requested. -**Note:** It is recommended to use your Fully Qualified Domain Name (FQDN) as the messaging hostname rather than `localhost`, ensure that a resolvable and reachable non-localhost name entry is present in `/etc/hosts`. +3. Restart `evmserverd` to pick up the changes. + +**Note:** Use your Fully Qualified Domain Name (FQDN) as the messaging hostname rather than `localhost`, ensure that a resolvable and reachable non-localhost name entry is present in `/etc/hosts`. ### Configuring a Worker Appliance From 41a0b02ded8a5bf7257ea9d8ea7b6c96d5463d52 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:52:54 -0400 Subject: [PATCH 05/25] Minor change --- _includes/initial-login-changepw.md | 2 +- _includes/initial-login.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/initial-login-changepw.md b/_includes/initial-login-changepw.md index 54a9ca452..04619fa52 100644 --- a/_includes/initial-login-changepw.md +++ b/_includes/initial-login-changepw.md @@ -1,7 +1,7 @@ Change your password to ensure more private and secure access to {{ site.data.product.title_short }}. -1. Browse to the URL for the login screen. +1. Browse to the URL for the login screen. For example, URL should be `https://xx.xx.xx.xx`. 2. Click **Update Password** beneath the **Username** and **Password** text fields. diff --git a/_includes/initial-login.md b/_includes/initial-login.md index d2d5d6ba5..37d044986 100644 --- a/_includes/initial-login.md +++ b/_includes/initial-login.md @@ -1,7 +1,7 @@ Once {{ site.data.product.title_short }} is installed, you can log in and perform administration tasks. -1. Browse to the URL for the login screen. +1. Browse to the URL for the login screen. For example, URL should be `https://xx.xx.xx.xx` 2. Enter the default credentials as listed for the initial login. - **Username**: **admin** From 3079587d88e28940b52fe996bee972f09d0319f6 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Thu, 22 Aug 2024 19:57:56 -0400 Subject: [PATCH 06/25] Updated ToC Added following additional topics to ToC: - Creating a Service in for Virtual Machine Provisioning - Service Provisioning Using an Orchestration Template - Assigning a Custom Analysis Profile to a Virtual Machine --- _data/site_menu.yml | 165 +++++++++++++++++++++++--------------------- 1 file changed, 86 insertions(+), 79 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index c3c721ab6..18a4c159c 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -1,7 +1,7 @@ --- -installation: - title: Installation +installing: + title: Installing children: - title: Amazon Web Services (AWS) path: "/docs/reference/latest/installing_on_aws/index.html" @@ -31,47 +31,58 @@ installation: path: "/docs/reference/latest/installing_on_scvmm/index.html" desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft System Center Virtual Machine Manager (SCVMM)" -appliances: - title: Appliances +upgrading: + title: Upgrading children: - - title: Backup and Restore - path: "/docs/reference/latest/appliances/backup_and_restore.html" - desc: "How to backup and restore appliances" - title: Upgrading path: "/docs/reference/latest/appliances/upgrading.html" desc: "How to upgrade appliances" -configuration: - title: Configuration - children: - - title: Deployment Planning Guide - path: "/docs/reference/latest/deployment_planning_guide/index.html" - desc: "ManageIQ Deployment Planning Guide" - - title: General Configuration - path: "/docs/reference/latest/general_configuration/index.html" - desc: "ManageIQ General Configuration" - - title: High Availability Guide - path: "/docs/reference/latest/high_availability_guide/index.html" - desc: "ManageIQ High Availability Guide" - - title: Appliance Hardening Guide - path: "/docs/reference/latest/appliance_hardening_guide/index.html" - desc: "ManageIQ Appliance Hardening Guide" - administration: title: Administration + children: + - title: Provisioning Virtual Machines and Hosts + path: "/docs/reference/latest/provisioning_virtual_machines_and_hosts/index.html" + desc: "Provisioning, workload management, and orchestration in ManageIQ" + - title: Service Provisioning Using an Orchestration Template + path: "/docs/reference/latest/service_provisioning_using_an_orchestration_template/index.html" + desc: "How to create orchestration template to deploy services" + - title: Creating a Service in for Virtual Machine Provisioning + path: "/docs/reference/latest/creating_a_service_for_vm_provisioning/index.html" + desc: "How to create a service for virtual machine provisioning" + - title: Assigning a Custom Analysis Profile to a Virtual Machine + path: "/docs/reference/latest/assigning_custom_analysis_profile_to_vm/index.html" + desc: "How to assign custom analysis profile to a virtual machine" + - title: Backup and Restore (appliances) + path: "/docs/reference/latest/appliances/backup_and_restore.html" + desc: "How to backup and restore appliances" + +visualizing: + title: Visualizing infrastructure + children: + - title: Managing Infrastructure and Inventory + path: "/docs/reference/latest/managing_infrastructure_and_inventory/index.html" + desc: "Viewing and collecting information from your clusters, hosts, virtual machines, and other resources" + +controls: + title: Managing controls children: - title: Monitoring, Alerts, and Reporting path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html" desc: "Information on the Cloud Intelligence area of ManageIQ: reporting, RSS, usage, timelines, and chargeback" - - title: Policies and Profiles Guide path: "/docs/reference/latest/policies_and_profiles_guide/index.html" desc: Policy-based enforcement, compliance, events, and policy profiles for ManageIQ - - title: Managing Infrastructure and Inventory - path: "/docs/reference/latest/managing_infrastructure_and_inventory/index.html" - desc: "Viewing and collecting information from your clusters, hosts, virtual machines, and other resources" - +integration: + title: Managing Integrations + children: + - title: AWS CloudFormation and OpenStack Heat + path: "/docs/reference/latest/integration_with_aws_cloudformation_and_openstack_heat/index.html" + desc: "How to install and configure Amazon CloudFormation and OpenStack Heat in a Red Hat ManageIQ environment" + - title: ServiceNow + path: "/docs/reference/latest/integration_with_servicenow/index.html" + desc: A short guide to managing ManageIQ ServiceNow CMDB integration - title: Managing Providers children: - title: Overview @@ -179,65 +190,61 @@ administration: path: "/docs/reference/latest/managing_providers/storage_providers/ibm_cloud_object_storage_managers.html" desc: "Managing IBM Cloud Object Storage Providers" - - title: Provisioning Virtual Machines and Hosts - path: "/docs/reference/latest/provisioning_virtual_machines_and_hosts/index.html" - desc: "Provisioning, workload management, and orchestration in ManageIQ" - - - title: Scripting Actions in ManageIQ - path: "/docs/reference/latest/scripting_actions/index.html" - desc: "Real-time, bi-directional process integration for ManageIQ Management Engine" - -troubleshooting: - title: Troubleshooting - children: - - title: Troubleshooting - path: "/docs/reference/latest/troubleshooting/index.html" - desc: "How to troubleshoot issues" - -authentication: - title: Authentication - children: - - title: Active Directory - path: "/docs/reference/latest/auth/active_directory.html" - desc: "How to manually configure an Appliance’s external authentication to work against Active Directory." - - title: 2-Factor-Authentication with IPA - path: "/docs/reference/latest/auth/ipa_2fa.html" - desc: "How to manually configure an Appliance’s external authentication to work with 2-Factor Authentication with IPA." - - title: IPA/AD Trust - path: "/docs/reference/latest/auth/ipa_ad_trust.html" - desc: "How to manually configure an Appliance’s external authentication to work with AD Trust Authentication using IPA." - - title: LDAP - path: "/docs/reference/latest/auth/ldap.html" - desc: "How to manually configure an Appliance’s external authentication to work against LDAP." - - title: SAML - path: "/docs/reference/latest/auth/saml.html" - desc: "How to manually configure an Appliance’s external authentication to work with SAML." - - title: OpenID-Connect - path: "/docs/reference/latest/auth/openid_connect.html" - desc: "How to manually configure an Appliance’s external authentication to work with OIDC." - -integration: - title: Integration +apis: + title: APIs children: - - title: AWS CloudFormation and OpenStack Heat - path: "/docs/reference/latest/integration_with_aws_cloudformation_and_openstack_heat/index.html" - desc: "How to install and configure Amazon CloudFormation and OpenStack Heat in a Red Hat ManageIQ environment" - - - title: ServiceNow - path: "/docs/reference/latest/integration_with_servicenow/index.html" - desc: A short guide to managing ManageIQ ServiceNow CMDB integration + - title: ManageIQ REST API + path: "/docs/api" + desc: REST API reference reference: title: Reference children: + - title: Deployment Planning Guide + path: "/docs/reference/latest/deployment_planning_guide/index.html" + desc: "ManageIQ Deployment Planning Guide" + - title: General Configuration + path: "/docs/reference/latest/general_configuration/index.html" + desc: "ManageIQ General Configuration" + - title: High Availability Guide + path: "/docs/reference/latest/high_availability_guide/index.html" + desc: "ManageIQ High Availability Guide" + - title: Managing Authentication for {{ site.data.product.title_short }} + children: + - title: Active Directory + path: "/docs/reference/latest/auth/active_directory.html" + desc: "How to manually configure an Appliance’s external authentication to work against Active Directory." + - title: 2-Factor-Authentication with IPA + path: "/docs/reference/latest/auth/ipa_2fa.html" + desc: "How to manually configure an Appliance’s external authentication to work with 2-Factor Authentication with IPA." + - title: IPA/AD Trust + path: "/docs/reference/latest/auth/ipa_ad_trust.html" + desc: "How to manually configure an Appliance’s external authentication to work with AD Trust Authentication using IPA." + - title: LDAP + path: "/docs/reference/latest/auth/ldap.html" + desc: "How to manually configure an Appliance’s external authentication to work against LDAP." + - title: SAML + path: "/docs/reference/latest/auth/saml.html" + desc: "How to manually configure an Appliance’s external authentication to work with SAML." + - title: OpenID-Connect + path: "/docs/reference/latest/auth/openid_connect.html" + desc: "How to manually configure an Appliance’s external authentication to work with OIDC." + - title: Appliance Hardening Guide + path: "/docs/reference/latest/appliance_hardening_guide/index.html" + desc: "ManageIQ Appliance Hardening Guide" - title: Capabilities Matrix path: "/docs/reference/latest/capabilities_matrix/index.html" desc: Capabilities across Providers - - - title: ManageIQ REST API - path: "/docs/api" - desc: REST API reference - - title: Methods Available for Automation path: "/docs/reference/latest/methods_available_for_automation/index.html" desc: Advanced automation methods for ManageIQ Management Engine + - title: Scripting Actions in ManageIQ + path: "/docs/reference/latest/scripting_actions/index.html" + desc: "Real-time, bi-directional process integration for ManageIQ Management Engine" + +troubleshooting: + title: Troubleshooting + children: + - title: Troubleshooting + path: "/docs/reference/latest/troubleshooting/index.html" + desc: "How to troubleshoot issues" From ca4ea92a2ec5ccad4a8fe2ffb92589e841c3d284 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed Date: Mon, 26 Aug 2024 16:49:12 -0400 Subject: [PATCH 07/25] Update embedded_workflows.md --- managing_providers/_topics/embedded_workflows.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/managing_providers/_topics/embedded_workflows.md b/managing_providers/_topics/embedded_workflows.md index ae21bd529..b8db46f6c 100644 --- a/managing_providers/_topics/embedded_workflows.md +++ b/managing_providers/_topics/embedded_workflows.md @@ -165,6 +165,8 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au The workflow code must be in the Amazon States Language (ASL) format and follow its supported specifications. For more information about Amazon States Language and its specification, see [Amazon States Language Guide](https://states-language.net/). + Amazon States Language does not support **Map** and **Parallel** states. + 2. Build the docker containers that are required for the workflow. When you have the code for your task resource written, you need to bundle it into a docker image. You can bundle the code by creating a standard [Dockerfile](https://docs.docker.com/engine/reference/builder/) and building the image (https://docs.docker.com/engine/reference/commandline/build/). Then, you can push the image to a [registry](https://docs.docker.com/engine/reference/commandline/push/), which makes the image available to be used by {{ site.data.product.title_short }}. When you have pushed your images to an image registry, you can add the registry to {{ site.data.product.title_short }}. From 03cdd225c29c86089fdb752fbe5a6fce1c8389b4 Mon Sep 17 00:00:00 2001 From: Keenan Brock Date: Mon, 26 Aug 2024 19:03:41 -0400 Subject: [PATCH 08/25] memo on Map and Parallel --- managing_providers/_topics/embedded_workflows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/managing_providers/_topics/embedded_workflows.md b/managing_providers/_topics/embedded_workflows.md index b8db46f6c..7f421b9cb 100644 --- a/managing_providers/_topics/embedded_workflows.md +++ b/managing_providers/_topics/embedded_workflows.md @@ -165,7 +165,7 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au The workflow code must be in the Amazon States Language (ASL) format and follow its supported specifications. For more information about Amazon States Language and its specification, see [Amazon States Language Guide](https://states-language.net/). - Amazon States Language does not support **Map** and **Parallel** states. + NOTE: This implementation of the Amazon States Language does not currently support **Map** and **Parallel** states. 2. Build the docker containers that are required for the workflow. From e3bdf4ac292480524add341ea5c4a7f282b04a75 Mon Sep 17 00:00:00 2001 From: qahmed1998 <156451706+qahmed1998@users.noreply.github.com> Date: Tue, 27 Aug 2024 11:03:25 -0400 Subject: [PATCH 09/25] Update embedded_workflows.md --- managing_providers/_topics/embedded_workflows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/managing_providers/_topics/embedded_workflows.md b/managing_providers/_topics/embedded_workflows.md index 7f421b9cb..b6bcd7742 100644 --- a/managing_providers/_topics/embedded_workflows.md +++ b/managing_providers/_topics/embedded_workflows.md @@ -165,7 +165,7 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au The workflow code must be in the Amazon States Language (ASL) format and follow its supported specifications. For more information about Amazon States Language and its specification, see [Amazon States Language Guide](https://states-language.net/). - NOTE: This implementation of the Amazon States Language does not currently support **Map** and **Parallel** states. + **Note**: The current implementation of the Amazon States Language does not support **Map** and **Parallel** states. 2. Build the docker containers that are required for the workflow. From 7e652df112005ba57b410f67ba102cc8543aa6b6 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Thu, 5 Sep 2024 16:05:05 -0400 Subject: [PATCH 10/25] Updated Installing section Added Podified and Appliance categories for "Installing" --- _data/site_menu.yml | 58 ++++++++++++++++++++++++--------------------- 1 file changed, 31 insertions(+), 27 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 18a4c159c..63029645c 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -3,33 +3,37 @@ installing: title: Installing children: - - title: Amazon Web Services (AWS) - path: "/docs/reference/latest/installing_on_aws/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Amazon Web Services (AWS)" - - title: Kubernetes - path: "/docs/reference/latest/installing_on_kubernetes/index.html" - desc: "How to install and configure ManageIQ on Kubernetes" - - title: IBM Cloud - path: "/docs/reference/latest/installing_on_ibm_cloud/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on IBM Cloud" - - title: Microsoft Azure - path: "/docs/reference/latest/installing_on_microsoft_azure/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft Azure" - - title: Google Compute Engine - path: "/docs/reference/latest/installing_on_google_compute_engine/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Google Compute Engine" - - title: VMware vSphere - path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on VMware vSphere" - - title: Red Hat Enterprise OpenStack Platform - path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat OpenStack Platform" - - title: Red Hat Enterprise Virtualization - path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat Enterprise Virtualization" - - title: Microsoft System Center Virtual Machine Manager (SCVMM) - path: "/docs/reference/latest/installing_on_scvmm/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft System Center Virtual Machine Manager (SCVMM)" + - title: Containerized (podified) + children: + - title: Kubernetes + path: "/docs/reference/latest/installing_on_kubernetes/index.html" + desc: "How to install and configure ManageIQ on Kubernetes" + - title: Appliance + children: + - title: Amazon Web Services (AWS) + path: "/docs/reference/latest/installing_on_aws/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on Amazon Web Services (AWS)" + - title: IBM Cloud + path: "/docs/reference/latest/installing_on_ibm_cloud/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on IBM Cloud" + - title: Microsoft Azure + path: "/docs/reference/latest/installing_on_microsoft_azure/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft Azure" + - title: Google Compute Engine + path: "/docs/reference/latest/installing_on_google_compute_engine/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on Google Compute Engine" + - title: VMware vSphere + path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on VMware vSphere" + - title: Red Hat Enterprise OpenStack Platform + path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat OpenStack Platform" + - title: Red Hat Enterprise Virtualization + path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat Enterprise Virtualization" + - title: Microsoft System Center Virtual Machine Manager (SCVMM) + path: "/docs/reference/latest/installing_on_scvmm/index.html" + desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft System Center Virtual Machine Manager (SCVMM)" upgrading: title: Upgrading From 46a9a662bb2402cb92396fc271552983ee808563 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 9 Sep 2024 15:37:28 -0400 Subject: [PATCH 11/25] Updated to the "NEW" agreed ToC --- _data/site_menu.yml | 122 ++++++++++++++++++++++---------------------- 1 file changed, 60 insertions(+), 62 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 63029645c..ad545d69e 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -42,51 +42,15 @@ upgrading: path: "/docs/reference/latest/appliances/upgrading.html" desc: "How to upgrade appliances" -administration: - title: Administration - children: - - title: Provisioning Virtual Machines and Hosts - path: "/docs/reference/latest/provisioning_virtual_machines_and_hosts/index.html" - desc: "Provisioning, workload management, and orchestration in ManageIQ" - - title: Service Provisioning Using an Orchestration Template - path: "/docs/reference/latest/service_provisioning_using_an_orchestration_template/index.html" - desc: "How to create orchestration template to deploy services" - - title: Creating a Service in for Virtual Machine Provisioning - path: "/docs/reference/latest/creating_a_service_for_vm_provisioning/index.html" - desc: "How to create a service for virtual machine provisioning" - - title: Assigning a Custom Analysis Profile to a Virtual Machine - path: "/docs/reference/latest/assigning_custom_analysis_profile_to_vm/index.html" - desc: "How to assign custom analysis profile to a virtual machine" - - title: Backup and Restore (appliances) - path: "/docs/reference/latest/appliances/backup_and_restore.html" - desc: "How to backup and restore appliances" - -visualizing: - title: Visualizing infrastructure +using: + title: Using children: + - title: General Configuration + path: "/docs/reference/latest/general_configuration/index.html" + desc: "ManageIQ General Configuration" - title: Managing Infrastructure and Inventory path: "/docs/reference/latest/managing_infrastructure_and_inventory/index.html" desc: "Viewing and collecting information from your clusters, hosts, virtual machines, and other resources" - -controls: - title: Managing controls - children: - - title: Monitoring, Alerts, and Reporting - path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html" - desc: "Information on the Cloud Intelligence area of ManageIQ: reporting, RSS, usage, timelines, and chargeback" - - title: Policies and Profiles Guide - path: "/docs/reference/latest/policies_and_profiles_guide/index.html" - desc: Policy-based enforcement, compliance, events, and policy profiles for ManageIQ - -integration: - title: Managing Integrations - children: - - title: AWS CloudFormation and OpenStack Heat - path: "/docs/reference/latest/integration_with_aws_cloudformation_and_openstack_heat/index.html" - desc: "How to install and configure Amazon CloudFormation and OpenStack Heat in a Red Hat ManageIQ environment" - - title: ServiceNow - path: "/docs/reference/latest/integration_with_servicenow/index.html" - desc: A short guide to managing ManageIQ ServiceNow CMDB integration - title: Managing Providers children: - title: Overview @@ -193,26 +157,33 @@ integration: - title: IBM Cloud Object Storage Providers path: "/docs/reference/latest/managing_providers/storage_providers/ibm_cloud_object_storage_managers.html" desc: "Managing IBM Cloud Object Storage Providers" + - title: Provisioning Virtual Machines and Hosts + path: "/docs/reference/latest/provisioning_virtual_machines_and_hosts/index.html" + desc: "Provisioning, workload management, and orchestration in ManageIQ" + - title: Creating a Service in for Virtual Machine Provisioning + path: "/docs/reference/latest/creating_a_service_for_vm_provisioning/index.html" + desc: "How to create a service for virtual machine provisioning" + - title: Service Provisioning Using an Orchestration Template + path: "/docs/reference/latest/service_provisioning_using_an_orchestration_template/index.html" + desc: "How to create orchestration template to deploy services" + - title: Managing controls + children: + - title: Monitoring, Alerts, and Reporting + path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html" + desc: "Information on the Cloud Intelligence area of ManageIQ: reporting, RSS, usage, timelines, and chargeback" + - title: Policies and Profiles Guide + path: "/docs/reference/latest/policies_and_profiles_guide/index.html" + desc: Policy-based enforcement, compliance, events, and policy profiles for ManageIQ + - title: Assigning a Custom Analysis Profile to a Virtual Machine + path: "/docs/reference/latest/assigning_custom_analysis_profile_to_vm/index.html" + desc: "How to assign custom analysis profile to a virtual machine" + - title: Scripting Actions in ManageIQ + path: "/docs/reference/latest/scripting_actions/index.html" + desc: "Real-time, bi-directional process integration for ManageIQ Management Engine" -apis: - title: APIs - children: - - title: ManageIQ REST API - path: "/docs/api" - desc: REST API reference - -reference: - title: Reference +administration: + title: Administering {{ site.data.product.title_short }} children: - - title: Deployment Planning Guide - path: "/docs/reference/latest/deployment_planning_guide/index.html" - desc: "ManageIQ Deployment Planning Guide" - - title: General Configuration - path: "/docs/reference/latest/general_configuration/index.html" - desc: "ManageIQ General Configuration" - - title: High Availability Guide - path: "/docs/reference/latest/high_availability_guide/index.html" - desc: "ManageIQ High Availability Guide" - title: Managing Authentication for {{ site.data.product.title_short }} children: - title: Active Directory @@ -233,18 +204,45 @@ reference: - title: OpenID-Connect path: "/docs/reference/latest/auth/openid_connect.html" desc: "How to manually configure an Appliance’s external authentication to work with OIDC." + - title: Backup and Restore (appliances) + path: "/docs/reference/latest/appliances/backup_and_restore.html" + desc: "How to backup and restore appliances" + - title: Deployment Planning Guide + path: "/docs/reference/latest/deployment_planning_guide/index.html" + desc: "ManageIQ Deployment Planning Guide" + - title: High Availability Guide + path: "/docs/reference/latest/high_availability_guide/index.html" + desc: "ManageIQ High Availability Guide" - title: Appliance Hardening Guide path: "/docs/reference/latest/appliance_hardening_guide/index.html" desc: "ManageIQ Appliance Hardening Guide" + +Defining integrations: + title: Managing Integrations + children: + - title: AWS CloudFormation and OpenStack Heat + path: "/docs/reference/latest/integration_with_aws_cloudformation_and_openstack_heat/index.html" + desc: "How to install and configure Amazon CloudFormation and OpenStack Heat in a Red Hat ManageIQ environment" + - title: ServiceNow + path: "/docs/reference/latest/integration_with_servicenow/index.html" + desc: A short guide to managing ManageIQ ServiceNow CMDB integration + +apis: + title: APIs + children: + - title: ManageIQ REST API + path: "/docs/api" + desc: REST API reference + +reference: + title: Reference + children: - title: Capabilities Matrix path: "/docs/reference/latest/capabilities_matrix/index.html" desc: Capabilities across Providers - title: Methods Available for Automation path: "/docs/reference/latest/methods_available_for_automation/index.html" desc: Advanced automation methods for ManageIQ Management Engine - - title: Scripting Actions in ManageIQ - path: "/docs/reference/latest/scripting_actions/index.html" - desc: "Real-time, bi-directional process integration for ManageIQ Management Engine" troubleshooting: title: Troubleshooting From 5fefff63b968359fe7e3050bc9311fcbf3218f40 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 9 Sep 2024 15:51:39 -0400 Subject: [PATCH 12/25] Added new page for Automation Management Providers --- _data/site_menu.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index ad545d69e..09f999830 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -88,6 +88,10 @@ using: path: "/docs/reference/latest/managing_providers/configuration_management_providers/red_hat_satellite_6.html" desc: "Managing Red Hat Satellite 6 Providers" + - title: Automation Management Providers + path: "/docs/reference/latest/managing_providers/index.html#automation-management-provider" + desc: "Management tool to simplify automation operators for resources" + - title: Cloud Providers children: - title: Azure Providers From aa6fef94d4640f204614b6dd37bccc7d98957f8b Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 9 Sep 2024 15:52:49 -0400 Subject: [PATCH 13/25] minor update to description --- _data/site_menu.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 09f999830..63d58fae9 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -183,7 +183,7 @@ using: desc: "How to assign custom analysis profile to a virtual machine" - title: Scripting Actions in ManageIQ path: "/docs/reference/latest/scripting_actions/index.html" - desc: "Real-time, bi-directional process integration for ManageIQ Management Engine" + desc: "Real-time, bi-directional process integration for ManageIQ" administration: title: Administering {{ site.data.product.title_short }} From ce92f022900fafa053486124f9a41d22f7ddd3c5 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 9 Sep 2024 15:57:53 -0400 Subject: [PATCH 14/25] Added "Chargeback" topic --- _data/site_menu.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 63d58fae9..890ca5ae9 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -178,6 +178,9 @@ using: - title: Policies and Profiles Guide path: "/docs/reference/latest/policies_and_profiles_guide/index.html" desc: Policy-based enforcement, compliance, events, and policy profiles for ManageIQ + - title: Chargeback + path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html#chargeback" + desc: Calculate monetary virtual machine charges based on owner or company tag - title: Assigning a Custom Analysis Profile to a Virtual Machine path: "/docs/reference/latest/assigning_custom_analysis_profile_to_vm/index.html" desc: "How to assign custom analysis profile to a virtual machine" From bde49f24e6caaea905c0d93f38c9efa7d3a54b68 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 9 Sep 2024 16:45:50 -0400 Subject: [PATCH 15/25] Update site_menu.yml --- _data/site_menu.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 890ca5ae9..370e980da 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -164,12 +164,12 @@ using: - title: Provisioning Virtual Machines and Hosts path: "/docs/reference/latest/provisioning_virtual_machines_and_hosts/index.html" desc: "Provisioning, workload management, and orchestration in ManageIQ" - - title: Creating a Service in for Virtual Machine Provisioning + - title: Creating a Service for Virtual Machine Provisioning path: "/docs/reference/latest/creating_a_service_for_vm_provisioning/index.html" desc: "How to create a service for virtual machine provisioning" - title: Service Provisioning Using an Orchestration Template path: "/docs/reference/latest/service_provisioning_using_an_orchestration_template/index.html" - desc: "How to create orchestration template to deploy services" + desc: "How to create an orchestration template to deploy services" - title: Managing controls children: - title: Monitoring, Alerts, and Reporting From 35ccb402bb08a96098e9a45cc67477eed1ad87d9 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Mon, 9 Sep 2024 17:07:33 -0400 Subject: [PATCH 16/25] update to description --- _data/site_menu.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 370e980da..f54d5f325 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -174,7 +174,7 @@ using: children: - title: Monitoring, Alerts, and Reporting path: "/docs/reference/latest/monitoring_alerts_and_reporting/index.html" - desc: "Information on the Cloud Intelligence area of ManageIQ: reporting, RSS, usage, timelines, and chargeback" + desc: "Information on the Cloud Intelligence area of ManageIQ: dashboards, widgets, reporting, chargeback, optimization, and alerts" - title: Policies and Profiles Guide path: "/docs/reference/latest/policies_and_profiles_guide/index.html" desc: Policy-based enforcement, compliance, events, and policy profiles for ManageIQ From 2557ad90b37268668779bfb4586603782985029e Mon Sep 17 00:00:00 2001 From: Qasim Ahmed <156451706+qahmed1998@users.noreply.github.com> Date: Wed, 11 Sep 2024 10:07:54 -0400 Subject: [PATCH 17/25] Removed ManageIQ Management Engine --- _data/site_menu.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index f54d5f325..7532d1d67 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -12,28 +12,28 @@ installing: children: - title: Amazon Web Services (AWS) path: "/docs/reference/latest/installing_on_aws/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Amazon Web Services (AWS)" + desc: "How to install and configure the ManageIQ on Amazon Web Services (AWS)" - title: IBM Cloud path: "/docs/reference/latest/installing_on_ibm_cloud/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on IBM Cloud" + desc: "How to install and configure the ManageIQ on IBM Cloud" - title: Microsoft Azure path: "/docs/reference/latest/installing_on_microsoft_azure/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft Azure" + desc: "How to install and configure the ManageIQ on Microsoft Azure" - title: Google Compute Engine path: "/docs/reference/latest/installing_on_google_compute_engine/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Google Compute Engine" + desc: "How to install and configure the ManageIQ on Google Compute Engine" - title: VMware vSphere path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on VMware vSphere" + desc: "How to install and configure the ManageIQ on VMware vSphere" - title: Red Hat Enterprise OpenStack Platform path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat OpenStack Platform" + desc: "How to install and configure the ManageIQ on Red Hat OpenStack Platform" - title: Red Hat Enterprise Virtualization path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Red Hat Enterprise Virtualization" + desc: "How to install and configure the ManageIQ on Red Hat Enterprise Virtualization" - title: Microsoft System Center Virtual Machine Manager (SCVMM) path: "/docs/reference/latest/installing_on_scvmm/index.html" - desc: "How to install and configure the ManageIQ Management Engine appliance on Microsoft System Center Virtual Machine Manager (SCVMM)" + desc: "How to install and configure the ManageIQ on Microsoft System Center Virtual Machine Manager (SCVMM)" upgrading: title: Upgrading @@ -249,7 +249,7 @@ reference: desc: Capabilities across Providers - title: Methods Available for Automation path: "/docs/reference/latest/methods_available_for_automation/index.html" - desc: Advanced automation methods for ManageIQ Management Engine + desc: Advanced automation methods for ManageIQ troubleshooting: title: Troubleshooting From 1785ef75ae4713af6875afb64b25e7e8d599a479 Mon Sep 17 00:00:00 2001 From: Jason Frey Date: Wed, 11 Sep 2024 12:38:55 -0400 Subject: [PATCH 18/25] Fix indenting issue in site_menu --- _data/site_menu.yml | 58 ++++++++++++++++++++++----------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 7532d1d67..9f1161faf 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -4,36 +4,36 @@ installing: title: Installing children: - title: Containerized (podified) - children: - - title: Kubernetes - path: "/docs/reference/latest/installing_on_kubernetes/index.html" - desc: "How to install and configure ManageIQ on Kubernetes" + children: + - title: Kubernetes + path: "/docs/reference/latest/installing_on_kubernetes/index.html" + desc: "How to install and configure ManageIQ on Kubernetes" - title: Appliance - children: - - title: Amazon Web Services (AWS) - path: "/docs/reference/latest/installing_on_aws/index.html" - desc: "How to install and configure the ManageIQ on Amazon Web Services (AWS)" - - title: IBM Cloud - path: "/docs/reference/latest/installing_on_ibm_cloud/index.html" - desc: "How to install and configure the ManageIQ on IBM Cloud" - - title: Microsoft Azure - path: "/docs/reference/latest/installing_on_microsoft_azure/index.html" - desc: "How to install and configure the ManageIQ on Microsoft Azure" - - title: Google Compute Engine - path: "/docs/reference/latest/installing_on_google_compute_engine/index.html" - desc: "How to install and configure the ManageIQ on Google Compute Engine" - - title: VMware vSphere - path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html" - desc: "How to install and configure the ManageIQ on VMware vSphere" - - title: Red Hat Enterprise OpenStack Platform - path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html" - desc: "How to install and configure the ManageIQ on Red Hat OpenStack Platform" - - title: Red Hat Enterprise Virtualization - path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html" - desc: "How to install and configure the ManageIQ on Red Hat Enterprise Virtualization" - - title: Microsoft System Center Virtual Machine Manager (SCVMM) - path: "/docs/reference/latest/installing_on_scvmm/index.html" - desc: "How to install and configure the ManageIQ on Microsoft System Center Virtual Machine Manager (SCVMM)" + children: + - title: Amazon Web Services (AWS) + path: "/docs/reference/latest/installing_on_aws/index.html" + desc: "How to install and configure the ManageIQ on Amazon Web Services (AWS)" + - title: IBM Cloud + path: "/docs/reference/latest/installing_on_ibm_cloud/index.html" + desc: "How to install and configure the ManageIQ on IBM Cloud" + - title: Microsoft Azure + path: "/docs/reference/latest/installing_on_microsoft_azure/index.html" + desc: "How to install and configure the ManageIQ on Microsoft Azure" + - title: Google Compute Engine + path: "/docs/reference/latest/installing_on_google_compute_engine/index.html" + desc: "How to install and configure the ManageIQ on Google Compute Engine" + - title: VMware vSphere + path: "/docs/reference/latest/installing_on_vmware_vsphere/index.html" + desc: "How to install and configure the ManageIQ on VMware vSphere" + - title: Red Hat Enterprise OpenStack Platform + path: "/docs/reference/latest/installing_on_red_hat_enterprise_linux_openstack_platform/index.html" + desc: "How to install and configure the ManageIQ on Red Hat OpenStack Platform" + - title: Red Hat Enterprise Virtualization + path: "/docs/reference/latest/installing_on_red_hat_virtualization/index.html" + desc: "How to install and configure the ManageIQ on Red Hat Enterprise Virtualization" + - title: Microsoft System Center Virtual Machine Manager (SCVMM) + path: "/docs/reference/latest/installing_on_scvmm/index.html" + desc: "How to install and configure the ManageIQ on Microsoft System Center Virtual Machine Manager (SCVMM)" upgrading: title: Upgrading From 847cd7182aa683b4cd62b07c2977468dd1c4dabd Mon Sep 17 00:00:00 2001 From: Qasim Ahmed Date: Tue, 17 Sep 2024 10:29:19 -0400 Subject: [PATCH 19/25] Fixed ToC issue --- _data/site_menu.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index 9f1161faf..bd3b2c5a2 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -189,9 +189,9 @@ using: desc: "Real-time, bi-directional process integration for ManageIQ" administration: - title: Administering {{ site.data.product.title_short }} + title: Administering children: - - title: Managing Authentication for {{ site.data.product.title_short }} + - title: Managing Authentication children: - title: Active Directory path: "/docs/reference/latest/auth/active_directory.html" @@ -224,7 +224,7 @@ administration: path: "/docs/reference/latest/appliance_hardening_guide/index.html" desc: "ManageIQ Appliance Hardening Guide" -Defining integrations: +integrations: title: Managing Integrations children: - title: AWS CloudFormation and OpenStack Heat From 3b98672bbac91a800f9306877d1f7801b4faa60f Mon Sep 17 00:00:00 2001 From: Nasar Khan Date: Wed, 25 Sep 2024 14:24:43 -0400 Subject: [PATCH 20/25] differentiate kubevirt and OSV --- _includes/provider-ocp-add-container.md | 2 +- capabilities_matrix/_topics/providers.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/_includes/provider-ocp-add-container.md b/_includes/provider-ocp-add-container.md index 4584d2392..21c498e3f 100644 --- a/_includes/provider-ocp-add-container.md +++ b/_includes/provider-ocp-add-container.md @@ -109,7 +109,7 @@ 9. In the **Virtualization** endpoint tab optionally configure the virtualization service details: - 1. Select a service type (OpenShift Virtualization / KubeVirt) or leave disabled + 1. Select a service type (OpenShift Virtualization) or leave disabled 2. Select a **Security Protocol** method to specify how to authenticate the service: diff --git a/capabilities_matrix/_topics/providers.md b/capabilities_matrix/_topics/providers.md index b5a1d974c..fbc1a2e0b 100644 --- a/capabilities_matrix/_topics/providers.md +++ b/capabilities_matrix/_topics/providers.md @@ -23,6 +23,7 @@ The following table lists providers that {{ site.data.product.title_short }} can | [Microsoft Azure Stack](#cloud-providers) | | [Microsoft System Center Virtual Machine Manager (SCVMM)](#infrastructure-providers) | | [Nuage Networks](#network-providers) | +| [OpenShift Virtualization](#infrastructure-providers) | | [OpenStack](#cloud-providers) | | [Oracle Cloud](#cloud-providers) | | [oVirt](#infrastructure-providers) | From f51b7ca46ec60efdcb936cadd38685c5abe0a44b Mon Sep 17 00:00:00 2001 From: Qasim Ahmed Date: Thu, 10 Oct 2024 16:56:58 -0400 Subject: [PATCH 21/25] Removed SCVMM provider --- _data/site_menu.yml | 4 ---- managing_providers/_topics/infrastructure_providers.md | 2 -- 2 files changed, 6 deletions(-) diff --git a/_data/site_menu.yml b/_data/site_menu.yml index bd3b2c5a2..e2728040d 100644 --- a/_data/site_menu.yml +++ b/_data/site_menu.yml @@ -70,10 +70,6 @@ using: path: "/docs/reference/latest/managing_providers/infrastructure_providers/vmware_vcenter_providers.html" desc: "Managing VMware vCenter Providers" - - title: Microsoft SCVMM Providers - path: "/docs/reference/latest/managing_providers/infrastructure_providers/microsoft_scvmm_providers.html" - desc: "Managing Microsoft SCVMM Providers" - - title: IBM Power HMC Providers path: "/docs/reference/latest/managing_providers/infrastructure_providers/ibm_power_hmc_providers.html" desc: "Managing IBM Power HMC Providers" diff --git a/managing_providers/_topics/infrastructure_providers.md b/managing_providers/_topics/infrastructure_providers.md index a562ab2a5..3fed7da1f 100644 --- a/managing_providers/_topics/infrastructure_providers.md +++ b/managing_providers/_topics/infrastructure_providers.md @@ -36,8 +36,6 @@ For information on managing specific infrastructure providers see the following. * [VMware vCenter Providers](./infrastructure_providers/vmware_vcenter_providers.html) -* [Microsoft SCVMM Providers](./infrastructure_providers/microsoft_scvmm_providers.html) - * [IBM Power HMC](./infrastructure_providers/ibm_power_hmc_providers.html) * [OpenShift Virtualization (KubeVirt)](./infrastructure_providers/kubevirt_providers.html) From 0f17e54264f5c265f67c0fecb5e40767dc946ca2 Mon Sep 17 00:00:00 2001 From: Qasim Ahmed Date: Fri, 11 Oct 2024 14:41:49 -0400 Subject: [PATCH 22/25] Removed SCVMM files --- ...center_virtual_machine_manager_provider.md | 53 ------------------- .../authenticating_to_microsoft_scvmm.md | 38 ------------- .../microsoft_scvmm_providers.md | 16 ------ 3 files changed, 107 deletions(-) delete mode 100644 managing_providers/infrastructure_providers/_topics/adding_a_microsoft_system_center_virtual_machine_manager_provider.md delete mode 100644 managing_providers/infrastructure_providers/_topics/authenticating_to_microsoft_scvmm.md delete mode 100644 managing_providers/infrastructure_providers/microsoft_scvmm_providers.md diff --git a/managing_providers/infrastructure_providers/_topics/adding_a_microsoft_system_center_virtual_machine_manager_provider.md b/managing_providers/infrastructure_providers/_topics/adding_a_microsoft_system_center_virtual_machine_manager_provider.md deleted file mode 100644 index 89249f809..000000000 --- a/managing_providers/infrastructure_providers/_topics/adding_a_microsoft_system_center_virtual_machine_manager_provider.md +++ /dev/null @@ -1,53 +0,0 @@ -## Adding a Microsoft SCVMM Provider - -After initial installation and creation of a {{ site.data.product.title_short }} -environment, add a Microsoft System Center Virtual Machine Manager -(SCVMM) provider to the appliance. - -**Note:** - -To authenticate the provider using a self-signed Certificate Authority (CA), configure the {{ site.data.product.title_short }} appliance to trust the -certificate using the steps in [Using a Self-Signed CA Certificate](#app-self_signed_CA) before adding -the provider. - -1. Browse to menu: **Compute > Infrastructure > Providers**. - -2. Click **Configuration**, then click - ![1862](../../images/1862.png) (**Add a New Infrastructure Provider**). - -3. Enter the **Name** of the provider to add. The **Name** is how the - device is labeled in the console. - -4. Select **Microsoft System Center VMM** from the **Type** list. - -5. Enter the **Host Name or IP address(IPv4 or IPv6)** of the provider. - -
- - The **Host Name** must use a unique fully qualified domain name. - -
- -6. Select **Kerberos** or **Basic (SSL)** from the **Security - Protocol** list. - - 1. For **Kerberos**: - - 1. Enter the user name and realm in the **Username** field. - - 2. Enter the password in the **Password** field. - - 3. Enter the password again in the **Confirm Password** field. - - 2. For **Basic (SSL)**: - - 1. Enter the user name in the **Username** field. - - 2. Enter the password in the **Password** field. - - 3. Enter the password again in the **Confirm Password** field. - -7. Click **Validate** to confirm that {{ site.data.product.title_short }} can connect to - the Microsoft System Center Virtual Machine Manager. - -8. Click **Add**. diff --git a/managing_providers/infrastructure_providers/_topics/authenticating_to_microsoft_scvmm.md b/managing_providers/infrastructure_providers/_topics/authenticating_to_microsoft_scvmm.md deleted file mode 100644 index dd7f11b71..000000000 --- a/managing_providers/infrastructure_providers/_topics/authenticating_to_microsoft_scvmm.md +++ /dev/null @@ -1,38 +0,0 @@ -## Authenticating to Microsoft SCVMM - -Before you can add a Microsoft SCVMM provider to your {{ site.data.product.title_short }} -environment, you must enable WinRM to listen for HTTP traffic on -Microsoft SCVMM servers. You must also set the appropriate execution -policy on the Microsoft SCVMM server to allow PowerShell scripts from -the appliance to run remotely. - -1. Log in to the Microsoft SCVMM server. - -2. Enable WinRM for configuration. - - winrm quickconfig - -3. Set the following options: - - winrm set winrm/config/client/auth @{Basic="true"} - winrm set winrm/config/service/auth @{Basic="true"} - winrm set winrm/config/service @{AllowUnencrypted="true"} - -4. For Windows 2012 R2 with PowerShell 4.0, use the following syntax to - set these options: - - winrm set winrm/config/client/auth '@{Basic="true"}' - winrm set winrm/config/service/auth '@{Basic="true"}' - winrm set winrm/config/service '@{AllowUnencrypted="true"}' - -5. Enable remote script execution on the SCVMM server using the - Set-ExecutionPolicy cmdlet. - - Set-ExecutionPolicy RemoteSigned - - For more information on SCVMM remote script execution policies, see - [Using the Set-ExecutionPolicy - Cmdlet](http://technet.microsoft.com/en-us/library/ee176961.aspx). - -If PowerShell returns an error, search for `log_dos_error_results` in -`journalctl -t evm -t scvmm` or `oc logs` for information. diff --git a/managing_providers/infrastructure_providers/microsoft_scvmm_providers.md b/managing_providers/infrastructure_providers/microsoft_scvmm_providers.md deleted file mode 100644 index 6c7288bce..000000000 --- a/managing_providers/infrastructure_providers/microsoft_scvmm_providers.md +++ /dev/null @@ -1,16 +0,0 @@ ---- ---- - -# Microsoft SCVMM Providers - -To use a Microsoft System Center Virtual Machine Manager (SCVMM) -provider, add it to the appliance and set up the SCVMM server for -authentication. - -**Note:** - -To use a SCVMM provider, you must have at least one network adapter available for communication between the host and the SCVMM management server. Make sure that **Used by Management** is checked for this network adapter in the SCVMM host properties. - -{% include_relative _topics/authenticating_to_microsoft_scvmm.md %} - -{% include_relative _topics/adding_a_microsoft_system_center_virtual_machine_manager_provider.md %} From 2cfdc67aa86b6c840a42eb71b8b0294fe4f5656c Mon Sep 17 00:00:00 2001 From: Nasar Khan Date: Mon, 28 Oct 2024 16:17:39 -0400 Subject: [PATCH 23/25] remove parallel from not implemented --- managing_providers/_topics/embedded_workflows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/managing_providers/_topics/embedded_workflows.md b/managing_providers/_topics/embedded_workflows.md index b6bcd7742..d8929f856 100644 --- a/managing_providers/_topics/embedded_workflows.md +++ b/managing_providers/_topics/embedded_workflows.md @@ -165,7 +165,7 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au The workflow code must be in the Amazon States Language (ASL) format and follow its supported specifications. For more information about Amazon States Language and its specification, see [Amazon States Language Guide](https://states-language.net/). - **Note**: The current implementation of the Amazon States Language does not support **Map** and **Parallel** states. + **Note**: The current implementation of the Amazon States Language does not support **Map** states. 2. Build the docker containers that are required for the workflow. From 900e57c566ff12f915fccf6b0bb4effe313bbe73 Mon Sep 17 00:00:00 2001 From: Nasar Khan Date: Mon, 28 Oct 2024 16:18:33 -0400 Subject: [PATCH 24/25] mention floe map state fields not yet supported --- managing_providers/_topics/embedded_workflows.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/managing_providers/_topics/embedded_workflows.md b/managing_providers/_topics/embedded_workflows.md index d8929f856..666a09599 100644 --- a/managing_providers/_topics/embedded_workflows.md +++ b/managing_providers/_topics/embedded_workflows.md @@ -167,6 +167,14 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au **Note**: The current implementation of the Amazon States Language does not support **Map** states. + #### Unsupported States Language Features + + The following are not yet supported for Floe: + - Map State Fields: + - ItemReader + - ItemSelector/ItemBatcher + - ResultWriter + 2. Build the docker containers that are required for the workflow. When you have the code for your task resource written, you need to bundle it into a docker image. You can bundle the code by creating a standard [Dockerfile](https://docs.docker.com/engine/reference/builder/) and building the image (https://docs.docker.com/engine/reference/commandline/build/). Then, you can push the image to a [registry](https://docs.docker.com/engine/reference/commandline/push/), which makes the image available to be used by {{ site.data.product.title_short }}. When you have pushed your images to an image registry, you can add the registry to {{ site.data.product.title_short }}. From 3643dae38ba68f66afab0befa2c16e27cae28ff2 Mon Sep 17 00:00:00 2001 From: Nasar Khan Date: Tue, 29 Oct 2024 09:37:13 -0400 Subject: [PATCH 25/25] link to floe features not supported section --- managing_providers/_topics/embedded_workflows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/managing_providers/_topics/embedded_workflows.md b/managing_providers/_topics/embedded_workflows.md index 666a09599..b1386aa8f 100644 --- a/managing_providers/_topics/embedded_workflows.md +++ b/managing_providers/_topics/embedded_workflows.md @@ -165,7 +165,7 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au The workflow code must be in the Amazon States Language (ASL) format and follow its supported specifications. For more information about Amazon States Language and its specification, see [Amazon States Language Guide](https://states-language.net/). - **Note**: The current implementation of the Amazon States Language does not support **Map** states. + **Note**: The current implementation of the Amazon States Language does not support certain **Map** states. See [Unsupported States Language Features](#unsupported-states-language-features). #### Unsupported States Language Features