diff --git a/doc-Configuring_High_Availability/cfme/common b/doc-Configuring_High_Availability/cfme/common new file mode 120000 index 000000000..248927d21 --- /dev/null +++ b/doc-Configuring_High_Availability/cfme/common @@ -0,0 +1 @@ +../../common/ \ No newline at end of file diff --git a/doc-Configuring_High_Availability/cfme/common/Registering_Updating_Cloudforms.adoc b/doc-Configuring_High_Availability/cfme/common/Registering_Updating_Cloudforms.adoc deleted file mode 100644 index 01aa665bc..000000000 --- a/doc-Configuring_High_Availability/cfme/common/Registering_Updating_Cloudforms.adoc +++ /dev/null @@ -1,161 +0,0 @@ -[[Registering_Updating_Cloudforms]] -= Registering and Updating Red Hat CloudForms - -You can register appliances, edit customer information, and update appliances from the *Red Hat Updates* tab, accessible from menu:Settings[Configuration > Region] in the user interface. You can register your appliance to either Red Hat Content Delivery Network (CDN) or to a Red Hat Satellite server, which assign the necessary update packages to the CloudForms server. The subscription management service you register with will provide your systems with updates and allow additional management. - -The following tools are used during the update process: - -* `Yum` provides package installation, updates, and dependency checking. -* `Red Hat Subscription Manager` manages subscriptions and entitlements. -* `Red Hat Satellite Server` provides local system registration and updates from inside the customer’s firewall. - -[IMPORTANT] -====== -The update worker synchronizes the VMDB with the status of available CloudForms content every 12 hours. -====== - -[NOTE] -====== -Servers with the `RHN Mirror` role also act as a repository for other appliances to pull CloudForms package updates. -====== - -== Registering Appliances - -Before you can access and apply package updates, you must register and subscribe the CloudForms appliance to either Red Hat Content Delivery Network (CDN) or to a Red Hat Satellite server. - -You need the following to register your appliance: - -* Your Red Hat account login or Red Hat Network Satellite login -* A Red Hat subscription that covers your product - -image::common/cfme-register-appliance.png[] - -To register your appliance with Red Hat Subscription Management or Red Hat Satellite 6, first configure the region with your registration details. These settings will apply to all appliances in this region. - -To configure registration for a region: - -. Log in to the appliance as the `admin` user. -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Edit Registration*. -. Configure registration details for the CloudForms appliance using one of two available options: -.. To register with Red Hat Subscription Management: -... In *Register to*, select *Red Hat Subscription Management*. -... Enter the *Red Hat Subscription Management Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.5-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the Red Hat CloudForms repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat account information and click *Validate*. -... After your credentials are validated, click *Save*. -.. To register with Red Hat Satellite 6: -... In *Register to*, select *Red Hat Satellite 6*. -... Enter the *Red Hat Satellite 6 Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.5-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the Red Hat CloudForms repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat Satellite account information and click *Validate*. -... After your credentials are validated, click *Save*. - -Your appliance now appears in the *Appliance Updates* list as `Not registered`. - -To register your appliance: - -. Select the appliance from the *Appliance Updates* list. -. Click *Register* to subscribe the appliance and attach subscriptions. - -Registering and attaching subscriptions takes a few minutes. The subscription process is complete when the appliance reports that it is `Subscribed` under *Update Status*, and `Registered` under *Last Message*. - -image::common/appliance_subscribed.png[] - -You can now apply updates to your appliance. - -[[Updating_Appliances]] -== Updating Appliances - -An important part of securing Red Hat CloudForms is to ensure your appliances use the latest packages. -Package updates to the appliance contain patches for any software bugs, including possible security bugs. - -The *Red Hat Updates* tab enables you to check for updates and update registered appliances. Any services requiring a restart to apply updates are automatically restarted as part of the *Red Hat Updates* process. - -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Check For Updates* to search the Content Delivery Network (CDN) for any updated CloudForms packages. If an appliance update is available, it will be listed with the available version. -. Click *Apply CFME Update* to install and update CloudForms packages. The CloudForms service will be automatically restarted as needed. - - -[IMPORTANT] -====== -Red Hat recommends updating the appliance using the *Red Hat Updates* tab only, which automatically restarts services and the appliance if needed. Running updates from the command line requires manually restarting the CloudForms service and sometimes the appliance. If updating the CloudForms appliance from the command line, use the `yum -y update cfme-appliance` command to update only CloudForms and its dependencies, and to avoid any potential incompatibilities that could be introduced by running `yum update`. -====== - - -The following options are available in the *Appliance Updates* section of *Red Hat Updates*: - -.Options Available in Appliance Updates -[cols="1,1", frame="all", options="header"] -|=== -| - - Option - - -| - - Use - -| - Refresh List - - -| - Refreshes the list of appliances. - - -| - Check for Updates - - -| - Checks for all available CloudForms updates using `yum`. - -| - Register - - -| - Attempts to register the appliance if it is not already registered. CloudForms subscribes to the `rhel-x86_64-server-6-cf-me-3` RHN channel for RHN-registered appliances, and to the products designated by Red Hat product certification for subscription-manager registered appliances. The Red Hat Enterprise Linux channels are enabled by default on registration. In addition, CloudForms automatically checks for updates after registering. -| - Apply CFME Update - - -| - Applies updates to CloudForms packages only. Specifically, this option runs the `yum -y update cfme-appliance` command. This command installs every package listed in the dependency tree if it is not already installed. If a specific version of a package is required, that version of the package is installed or upgraded. No other packages, such as PostgreSQL or Red Hat Enterprise Linux, are updated. The appliance may be rebooted automatically during this process. - - -|=== - - -[NOTE] -====== -If the appliance is registered to Red Hat Satellite, you can use content views to manage updates for CloudForms. For more information, see https://access.redhat.com/documentation/en/red-hat-satellite/6.2/content-management-guide/chapter-7-creating-content-views[Creating Content Views] in the _Red Hat Satellite 6 Content Management Guide_. -====== - - -== Updating the Appliance Operating System - -Updating the appliance’s operating system requires a manual update using the `yum` command. This command updates the CloudForms packages, plus all RPMs on the appliance, and is supported only when used as part of migration. - -[IMPORTANT] -====== -Scheduled downtime is required while updating system packages for the following reasons: - -* Some updates may interrupt CloudForms operations. -* Updates for the PostgreSQL database server suspend CloudForms operations. -* System updates may require a reboot of the CloudForms appliance. - -Red Hat recommends updating the appliance using the *Red Hat Updates* tab in the CloudForms user interface, which automatically restarts services and the appliance if needed. See xref:Updating_Appliances[] for instructions. -====== - -To update the appliance operating system: - -. Log in to the appliance console as the root user. -. Run the `yum update` command and confirm any updates. -. Restart the appliance as required. diff --git a/doc-Configuring_High_Availability/cfme/common/attributes/cfme.adoc b/doc-Configuring_High_Availability/cfme/common/attributes/cfme.adoc deleted file mode 100644 index c2b13b632..000000000 --- a/doc-Configuring_High_Availability/cfme/common/attributes/cfme.adoc +++ /dev/null @@ -1,7 +0,0 @@ - -:product-title: Red Hat CloudForms -:product-title_short: CloudForms -:product-title_short_l: cloudforms -:product-title_abbr: cfme -:product-title_abbr_uc: CFME - diff --git a/doc-Configuring_High_Availability/cfme/common/attributes/miq.adoc b/doc-Configuring_High_Availability/cfme/common/attributes/miq.adoc deleted file mode 100644 index 95d9a6c77..000000000 --- a/doc-Configuring_High_Availability/cfme/common/attributes/miq.adoc +++ /dev/null @@ -1,7 +0,0 @@ - -:product-title: ManageIQ -:product-title_short: ManageIQ -:product-title_short_l: manageiq -:product-title_abbr: miq -:product-title_abbr_uc: MIQ - diff --git a/doc-Configuring_High_Availability/cfme/common/cap-util-assign-server-roles.adoc b/doc-Configuring_High_Availability/cfme/common/cap-util-assign-server-roles.adoc deleted file mode 100644 index b2866f0d1..000000000 --- a/doc-Configuring_High_Availability/cfme/common/cap-util-assign-server-roles.adoc +++ /dev/null @@ -1,14 +0,0 @@ -. Navigate to menu:Settings[Configuration], and select the server to configure from menu:Settings[Zone] in the left pane of the appliance. -. Navigate to the *Server Roles* list in the menu:Server[Server Control] section. From there, set the appropriate Capacity and Utilization roles to *ON*. Namely: -.. *Capacity & Utilization Coordinator* -.. *Capacity & Utilization Data Collector* -.. *Capacity & Utilization Data Processor* -. Click *Save*. - -Data collection is enabled immediately. However, the first collection begins -5 minutes after the server is started, and every 10 minutes after that. -Therefore, the longest the collection takes after enabling the Capacity & -Utilization collector server role is 10 minutes. The first collection -from a particular provider may take a few minutes since {product-title} -is gathering data points going one month back in time. - diff --git a/doc-Configuring_High_Availability/cfme/common/cap-util-note-metrics-collection.adoc b/doc-Configuring_High_Availability/cfme/common/cap-util-note-metrics-collection.adoc deleted file mode 100644 index 9144c1512..000000000 --- a/doc-Configuring_High_Availability/cfme/common/cap-util-note-metrics-collection.adoc +++ /dev/null @@ -1,2 +0,0 @@ -For metrics collection to work properly, you also need to configure {product-title} to allow for all three *Capacity & Utilization* server roles, which are available under menu:Configure[Configuration > Server > Server Control]. -ifdef::cfme[For more information on capacity and utilization collection, see https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/deployment-planning-guide/#assigning_the_capacity_and_utilization_server_roles[Assigning the Capacity and Utilization Server Roles] in the _Deployment Planning Guide_.] diff --git a/doc-Configuring_High_Availability/cfme/common/catalog-item-creation.adoc b/doc-Configuring_High_Availability/cfme/common/catalog-item-creation.adoc deleted file mode 100644 index 9199ad20d..000000000 --- a/doc-Configuring_High_Availability/cfme/common/catalog-item-creation.adoc +++ /dev/null @@ -1,25 +0,0 @@ -. Navigate to menu:Services[Catalogs]. -. Click the *Catalog Items* accordion. -. Click image:1847.png[](*Configuration*), and then image:1862.png[](*Add a New Catalog Item*). -. Select the *Catalog Item Type* you are adding. The dialogs that appear will be filtered based on the selected type of provider. For example, you will only see templates residing on Red Hat Providers, if the *Catalog Item Type* is *Redhat*. -image:2357.png[] -. In the *Basic Info* subtab: -.. Type a *Name/Description*. -.. Check *Display in Catalog* to edit *Catalog*, *Dialog*, and *Entry Point(NS/Cls/Inst)* options. -... *Provisioning Entry Point (Domain/NS/Cls/Inst)* requires you to select an Automate instance to run upon provisioning. -... *Retirement Entry Point (Domain/NS/Cls/Inst)* requires you to select an Automate instance to run upon retirement. -image:Catalogitem-statemachine.png[] -+ -[NOTE] -======== -The entry point must be a State Machine since the *Provisioning Entry Point* list is filtered to only show State Machine class instances. No other entry points will be available from the *Provisioning Entry Point* field. -======== -+ -[NOTE] -======== -You can only choose from the catalogs and dialogs you have already created. If you haven't done so, leave the values blank and edit later. -======== -+ -. In the *Details* subtab, write a *Long Description* for the catalog item. -. In the *Request Info* subtab, select provisioning options that apply to the provider chosen. For more information, refer to the sections on Provisioning Virtual Machines and Provisioning Instances. -. Click *Add*. diff --git a/doc-Configuring_High_Availability/cfme/common/catalog-order.adoc b/doc-Configuring_High_Availability/cfme/common/catalog-order.adoc deleted file mode 100644 index 81ce43e82..000000000 --- a/doc-Configuring_High_Availability/cfme/common/catalog-order.adoc +++ /dev/null @@ -1,10 +0,0 @@ -. Navigate to menu:Services[Catalogs]. -. Click the *Service Catalogs* accordion, and select the service to provision. -. Click *Order*. - -/////////////////////////////// -. Navigate to menu:Services[Catalogs]. -. Click the *Service Catalogs* accordion, and select the service to provision. -. Click *Order*. The dialog appears. -. Select the options in the *Service* dialog. -/////////////////////////////// diff --git a/doc-Configuring_High_Availability/cfme/common/cfme-install-appliance-as-vm.adoc b/doc-Configuring_High_Availability/cfme/common/cfme-install-appliance-as-vm.adoc deleted file mode 100644 index 13d9f171b..000000000 --- a/doc-Configuring_High_Availability/cfme/common/cfme-install-appliance-as-vm.adoc +++ /dev/null @@ -1,23 +0,0 @@ -// Using virt-manager command, we will install the CF appliance. Ensure the cfme.qcow2 file is placed in /var/lib/libvirt/images/ directory and make sure the security context of the file is correct. Use 4 vcpus and 8192 MiB of RAM for the appliance. Add a second network interface of virto type. - -. Log in as `root` to the virtual machine host. -. Copy the appliance to `/var/lib/libvirt/images/`. -. Run `virt-manager`. Doing so will launch the Virtual Machine Manager. -. Enter a name for the virtual machine in the *Name* field; for example, use `my-cfme`. Select *Import existing disk image* and click *Forward*. -+ -image:virt-manager-install-step1.png[] -. Click *Browse* to select the copy of the appliance stored in `/var/lib/libvirt/images/`. -+ -image:virt-manager-install-step2.png[] -+ -Select *Linux* from the *OS type* drop-down. For *Version*, select *Red Hat Enterprise Linux 7 or later*. Click *Forward*. -. Configure the appliance with 4 CPUs and 8192MiB or memory. Select *Customize configuration before install* then click *Finish*. -+ -image:virt-manager-install-step3.png[] -. Add a second network interface for the virtual machine. Select *virtio* as its *Device Model*. -+ -image:virt-manager-install-step4.png[] -. Configure the virtual machine with two additional virtual disks. One will be used for the internal database (xref:configuring_a_database[]), while the other will be used for mounting images and SmartState analysis. -+ -image:virt-manager-install-step5.png[] -. Click *Finish* to launch the virtual machine. diff --git a/doc-Configuring_High_Availability/cfme/common/cfme-obtaining-the-appliance.adoc b/doc-Configuring_High_Availability/cfme/common/cfme-obtaining-the-appliance.adoc deleted file mode 100644 index 9d83ebec4..000000000 --- a/doc-Configuring_High_Availability/cfme/common/cfme-obtaining-the-appliance.adoc +++ /dev/null @@ -1,5 +0,0 @@ -. Go to link:https://access.redhat.com[access.redhat.com] and log in to the Red Hat Customer Portal using your customer account details. -. Click *Downloads* in the menu bar. -. Click *A-Z* to sort the product downloads alphabetically. -. Click *Red Hat CloudForms* to access the product download page. The latest version of each download displays by default. -. From the list of installers and images under *Product Software*, choose *OpenStack Virtual Appliance* option with the latest version and click *Download Now*. diff --git a/doc-Configuring_High_Availability/cfme/common/chargeback-report-creation.adoc b/doc-Configuring_High_Availability/cfme/common/chargeback-report-creation.adoc deleted file mode 100644 index 62c7c511e..000000000 --- a/doc-Configuring_High_Availability/cfme/common/chargeback-report-creation.adoc +++ /dev/null @@ -1,29 +0,0 @@ -. Navigate to menu:Cloud Intel[Reports]. -. Click the *Reports* accordion. -. Click image:1847.png[]*(Configuration)*, image:1862.png[] *(Add a new Report)*. -. On the *Columns* tab, fill out the *Basic Report Info* area. -+ -* Type a unique name in *Menu Name* for how you want the report described in the menu list. -* Type the *Title* to display on the report. - -. Add fields in the *Configure Report Columns* area. -+ -* From the *Base the report on* list, select *Chargebacks*. -* Select the fields to include in the report from the *Available Fields* list, then click image:2289.png[] *(Move selected fields down)*. - In addition to the fields, you can also select any tags that you have created and assigned. -* Change the order of the fields in the report by clicking image:2290.png[] *(Move selected fields up)* or image:2289.png[] *(Move selected fields down)]*. - -. Click the *Formatting* tab to set the size of paper for a PDF and column header format. -+ -* From the *PDF Output* area, select the page size from the *Page Size* list. -* From *Specify Column Headers and Formats*, type the text to display for each field. - For each numeric field, you can also set the numeric format. - -. Click the *Filter* tab to set filters for the data displayed in the report. -+ -* From *Chargeback Filters*, select how you want the costs to show, the tag category, the tag, and how you want the items grouped. -* From *Chargeback Interval*, select the time interval. - You must have a full interval worth of data in order to select an option other than *Partial* in the *Daily Ending With* list. - -. Click the *Preview* tab, and then *Load* to see what the report will look like. -. When you are satisfied that you have the report that you want, click *Add* to create the new report. diff --git a/doc-Configuring_High_Availability/cfme/common/configuration-advanced.adoc b/doc-Configuring_High_Availability/cfme/common/configuration-advanced.adoc deleted file mode 100644 index c7cd348af..000000000 --- a/doc-Configuring_High_Availability/cfme/common/configuration-advanced.adoc +++ /dev/null @@ -1,30 +0,0 @@ -After logging in, you can use the following menu items for advanced configuration of the appliance: - -* Use *Set DHCP Network Configuration* to use DHCP to obtain the IP address and network configuration for your {product-title} appliance. The appliance is initially configured as a DHCP client with bridged networking. -* Use *Set Static Network Configuration* if you have a specific IP address and network settings you need to use for the {product-title} appliance. -* Use *Test Network Configuration* to check that name resolution is working correctly. -* Use *Set Hostname* to specify a hostname for the {product-title} appliance. -+ -[IMPORTANT] -==== -A valid fully qualified hostname for the {product-title} appliance is required for SmartState analysis to work correctly, -==== -+ -* Use *Set Timezone* to configure the time zone for the {product-title} appliance. -* Use *Set Date and Time* to configure the date and time for the {product-title} appliance. -* Use *Restore Database from Backup* to restore the Virtual Management Database (VMDB) from a previous backup. -* Use *Setup Database Region* to create regions for VMDB replication. -* Use *Configure Database* to configure the VMDB. Use this option to configure the database for the appliance after installing and running it for the first time. -* Use *Configure Database Replication* to configure a primary or standby server for VMDB replication. -* Use *Configure Database Maintenance* to configure the VMDB maintenance schedule. -* Use *Configure Application Database Failover Monitor* to start or stop VMDB failover monitoring. -* Use *Extend Temporary Storage* to add temporary storage to the appliance. The appliance formats an unpartitioned disk attached to the appliance host and mounts it at `/var/www/miq_tmp`. The appliance uses this temporary storage directory to perform certain image download functions. -* Use *Configure External Authentication (httpd)* to configure authentication through an IPA server. -* Use *Generate Custom Encryption Key* to regenerate the encryption key used to encode plain text password. -* Use *Harden Appliance Using SCAP Configuration* to apply Security Content Automation Protocol (SCAP) standards to the appliance. You can view these SCAP rules in the `/var/www/miq/lib/appliance_console/config/scap_rules.yml` file. -* Use *Stop EVM Server Processes* to stop all server processes. You may need to do this to perform maintenance. -* Use *Start EVM Server Processes* to start the server. You may need to do this after performing maintenance. -* Use *Restart Appliance* to restart the {product-title} appliance. You can either restart the appliance and clear the logs or just restart the appliance. -* Use *Shut Down Appliance* to power down the appliance and exit all processes. -* Use *Summary Information* to go back to the network summary screen for the {product-title} appliance. -* Use *Quit* to leave the {product-title} appliance console. diff --git a/doc-Configuring_High_Availability/cfme/common/configuration-db.adoc b/doc-Configuring_High_Availability/cfme/common/configuration-db.adoc deleted file mode 100644 index 2d299b437..000000000 --- a/doc-Configuring_High_Availability/cfme/common/configuration-db.adoc +++ /dev/null @@ -1,43 +0,0 @@ -[IMPORTANT] -==== -Before installing an internal database, add a disk to the infrastructure hosting your appliance. See the documentation specific to your infrastructure for instructions for adding a disk. As a storage disk usually cannot be added while a virtual machine is running, Red Hat recommends adding the disk before starting the appliance. {product-title} only supports installing of an internal VMDB on blank disks; installation will fail if the disks are not blank. -==== - -. Start the appliance and open a terminal from your virtualization or cloud provider. -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press *Enter* to manually configure settings. -. Select *8) Configure Database* from the menu. -. You are prompted to create or fetch an encryption key. -* If this is the first {product-title} appliance, choose *1) Create key*. -* If this is not the first {product-title} appliance, choose *2) Fetch key* from remote machine to fetch the key from the first {product-title} appliance. All {product-title} appliances in a multi-region deployment must use the same key. -. Choose *1) Internal* for the database location. -. Choose a disk for the database. This can be either a disk you attached previously, or a partition on the current disk. -+ -[IMPORTANT] -==== -Red Hat recommends using a separate disk for the database. -==== -+ -If there is an unpartitioned disk attached to the virtual machine, the dialog will show options similar to the following: -+ ----- -1) /dev/vdb: 20480 -2) Don't partition the disk ----- -+ -* Enter *1* to choose `/dev/vdb` for the database location. This option creates a logical volume using this device and mounts the volume to the appliance in a location appropriate for storing the database. The default location is `/var/opt/rh/rh-postgresql95/lib/pgsql`, which can be found in the environment variable `$APPLIANCE_PG_MOUNT_POINT`. -* Enter *2* to continue without partitioning the disk. A second prompt will confirm this choice. Selecting this option results in using the root filesystem for the data directory (not advised in most cases). -. Enter *Y* or *N* for *Configure this server as a dedicated database instance?* -* Select *Y* to configure the appliance _only_ as a database. As a result, the appliance is configured as a basic PostgreSQL server, without a user interface. -* Select *N* to configure the appliance with the full administrative user interface. -. When prompted, enter a unique number to create a new region. -+ -[IMPORTANT] -==== -Creating a new region destroys any existing data on the chosen database. -==== -+ -. Create and confirm a password for the database. - -{product-title} then configures the internal database. \ No newline at end of file diff --git a/doc-Configuring_High_Availability/cfme/common/configuration-gui.adoc b/doc-Configuring_High_Availability/cfme/common/configuration-gui.adoc deleted file mode 100644 index 4f86b7dbe..000000000 --- a/doc-Configuring_High_Availability/cfme/common/configuration-gui.adoc +++ /dev/null @@ -1,19 +0,0 @@ -The options under the *Configuration* menu allow you to configure global options for your {product-title} environment, view diagnostic information, and view analytics on the servers in the environment. The menu displays the {product-title} environment at the enterprise, zone, and server levels. - -There are four main areas: - -* *Settings* -+ -This menu allows you to configure global settings for your {product-title} infrastructure. You can also create analysis profiles and schedules for these profiles. -+ -* *Access Control* -+ -This menu contains options for configuring users, groups, roles, and tenants. -+ -* *Diagnostics* -+ -This menu displays the status of your servers and their roles and provides access to logs. -+ -* *Database* -+ -specify the location of your Virtual Machine Database (VMDB) and its login credentials. diff --git a/doc-Configuring_High_Availability/cfme/common/configuration-register-appliance.adoc b/doc-Configuring_High_Availability/cfme/common/configuration-register-appliance.adoc deleted file mode 100644 index 9929d15aa..000000000 --- a/doc-Configuring_High_Availability/cfme/common/configuration-register-appliance.adoc +++ /dev/null @@ -1,41 +0,0 @@ -Before you can access and apply package updates, you must register and subscribe the {product-title} appliance to either Red Hat Content Delivery Network (CDN) or to a Red Hat Satellite server. - -You need the following to register your appliance: - -* Your Red Hat account login or Red Hat Network Satellite login -* A Red Hat subscription that covers your product - -To register your appliance with Red Hat Subscription Management or Red Hat Satellite 6, first configure the region with your registration details. These settings will apply to all appliances in this region. - -To configure registration for a region: - -. Log in to the appliance as the `admin` user. -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Edit Registration*. -. Configure registration details for the {product-title} appliance using one of two available options: -.. To register with Red Hat Subscription Management: -... In *Register to*, select *Red Hat Subscription Management*. -... Enter the *Red Hat Subscription Management Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.7-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the {product-title} repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat account information and click *Validate*. -... After your credentials are validated, click *Save*. -.. To register with Red Hat Satellite 6: -... In *Register to*, select *Red Hat Satellite 6*. -... Enter the *Red Hat Satellite 6 Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.7-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the Red Hat CloudForms repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat Satellite account information and click *Validate*. -... After your credentials are validated, click *Save*. - -Your appliance now appears in the *Appliance Updates* list as `Not registered`. - -To register your appliance: - -. Select the appliance from the *Appliance Updates* list. -. Click *Register* to subscribe the appliance and attach subscriptions. - -Registering and attaching subscriptions takes a few minutes. The subscription process is complete when the appliance reports that it is `Subscribed` under *Update Status*, and `Registered` under *Last Message*. - -You can now apply updates to your appliance. diff --git a/doc-Configuring_High_Availability/cfme/common/configuration-update-appliance.adoc b/doc-Configuring_High_Availability/cfme/common/configuration-update-appliance.adoc deleted file mode 100644 index deb3a6f28..000000000 --- a/doc-Configuring_High_Availability/cfme/common/configuration-update-appliance.adoc +++ /dev/null @@ -1,10 +0,0 @@ -An important part of securing {product-title} is to ensure your appliances use the latest packages. -Package updates to the appliance contain patches for any software bugs, including possible security bugs. - -The *Red Hat Updates* tab enables you to check for updates and update registered appliances. Any services requiring a restart to apply updates are automatically restarted as part of the *Red Hat Updates* process. - -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Check For Updates* to search the Content Delivery Network (CDN) for any updated CloudForms packages. If an appliance update is available, it will be listed with the available version. -. Click *Apply CFME Update* to install and update {product-title} packages. The {product-title} service will be automatically restarted as needed. - diff --git a/doc-Configuring_High_Availability/cfme/common/configuration.adoc b/doc-Configuring_High_Availability/cfme/common/configuration.adoc deleted file mode 100644 index 67fc492b6..000000000 --- a/doc-Configuring_High_Availability/cfme/common/configuration.adoc +++ /dev/null @@ -1,94 +0,0 @@ -[[Configuring-cloudforms]] -== Configuring {product-title} - -Although the {product-title} appliance comes configured to be integrated immediately into your environment, you can make some changes to its configuration. - -[NOTE] -==== -The {product-title} appliance is intended to have minimal configuration options. -==== - -[[changing-configuration-settings]] -=== Changing Configuration Settings - -The following procedure describes how to make changes to the configuration settings on the {product-title} appliance. - -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press `Enter` to manually configure settings. -. Press the number for the item you want to change, and press `Enter`. The options for your selection are displayed. -. Follow the prompts to make the changes. -. Press `Enter` to accept a setting where applicable. - -[NOTE] -==== -The {product-title} appliance console automatically logs out after five minutes of inactivity. -==== - -[[advanced-configuration-settings]] -=== Advanced Configuration Settings - -include::configuration-advanced.adoc[] - -[[configuring_a_database]] -=== Configuring a Database for {product-title} - -Before using {product-title}, configure the database options for it. {product-title} provides two options for database configuration: - -* Install an internal PostgreSQL database to the appliance -* Configure the appliance to use an external PostgreSQL database - -[[configuring-an-internal-database]] -=== Configuring an Internal Database - -include::configuration-db.adoc[] - -[[configuring-an-external-database]] -=== Configuring an External Database - -The `postgresql.conf` file used with {product-title} databases requires specific settings for correct operation. For example, it must correctly reclaim table space, control session timeouts, and format the PostgreSQL server log for improved system support. Due to these requirements, Red Hat recommends that external {product-title} databases use a `postgresql.conf` file based on the standard file used by the {product-title} appliance. - -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 -necessary to alter the `max_connections` setting. - -Because the `postgresql.conf` file controls the operation of all databases managed by a single instance of PostgreSQL, do not mix {product-title} databases with other types of databases in a single PostgreSQL instance. - -[NOTE] -==== -{product-title} 4.x requires PostgreSQL version 9.4. -==== - -. Start the appliance and open a terminal console from your virtualization or cloud provider. -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press *Enter* to manually configure settings. -. Select *8) Configure Database* from the menu. -. You are prompted to create or fetch a security key. -* If this is the first {product-title} appliance, select the option to create a key. -* If this is not the first {product-title} appliance, select the option to fetch the key from the first {product-title} appliance. All {product-title} appliances in a multi-region deployment must use the same key. -. Choose *2) External* for the database location. -. Enter the database hostname or IP address when prompted. -. Enter the database name or leave blank for the default (`vmdb_production`). -. Enter the database username or leave blank for the default (`root`). -. Enter the chosen database user's password. -. Confirm the configuration if prompted. - -{product-title} will then configure the external database. - -[[configuring-a-worker-appliance]] -=== Configuring a Worker Appliance - -You can configure a worker appliance through the terminal. These steps demonstrate how to join a worker appliance to an appliance that already has a region configured with a database. - -. Start the appliance and open a terminal from your virtualization or cloud provider. -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press *Enter* to manually configure settings. -. Select *8) Configure Database* from the menu. -. You are prompted to create or fetch a security key. Select the option to fetch the key from the first {product-title} appliance. All {product-title} appliances in a multi-region deployment must use the same key. -. Choose *2) External* for the database location. -. Enter the database hostname or IP address when prompted. -. Enter the database name or leave blank for the default (`vmdb_production`). -. Enter the database username or leave blank for the default (`root`). -. Enter the chosen database user's password. -. Confirm the configuration if prompted. diff --git a/doc-Configuring_High_Availability/cfme/common/initial-login-changepw.adoc b/doc-Configuring_High_Availability/cfme/common/initial-login-changepw.adoc deleted file mode 100644 index 8203e559d..000000000 --- a/doc-Configuring_High_Availability/cfme/common/initial-login-changepw.adoc +++ /dev/null @@ -1,9 +0,0 @@ -Change your password to ensure more private and secure access to {product-title}. - -. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance) -. Click *Update Password* beneath the *Username* and *Password* text fields. -. Enter your current *Username* and *Password* in the text fields. -. Input a new password in the *New Password* field. -. Repeat your new password in the *Verify Password* field. -. Click *Login*. - diff --git a/doc-Configuring_High_Availability/cfme/common/initial-login.adoc b/doc-Configuring_High_Availability/cfme/common/initial-login.adoc deleted file mode 100644 index b1d76812a..000000000 --- a/doc-Configuring_High_Availability/cfme/common/initial-login.adoc +++ /dev/null @@ -1,8 +0,0 @@ - -Once {product-title} is installed, you can log in and perform administration tasks. - -Log in to {product-title} for the first time after installing by: - -. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance) -. Enter the default credentials (Username: *admin* | Password: *smartvm*) for the initial login. -. Click *Login*. diff --git a/doc-Configuring_High_Availability/cfme/common/introduction.adoc b/doc-Configuring_High_Availability/cfme/common/introduction.adoc deleted file mode 100644 index a085c0552..000000000 --- a/doc-Configuring_High_Availability/cfme/common/introduction.adoc +++ /dev/null @@ -1,197 +0,0 @@ -[[introduction]] -== Introduction to {product-title} - -{product-title} delivers the insight, control, and automation that enterprises need to address the challenges of managing virtual environments. -This technology enables enterprises with existing virtual infrastructures to improve visibility and control, and those starting virtualization deployments to build and operate a well-managed virtual infrastructure. - -{product-title} provides the following feature sets: - -* Insight: Discovery, Monitoring, Utilization, Performance, Reporting, Analytic, Chargeback, and Trending. -* Control: Security, Compliance, Alerting, and Policy-Based Resource, and Configuration Enforcement. -* Automate: IT Process, Task and Event, Provisioning, and Workload Management and Orchestration. -* Integrate: Systems Management, Tools and Processes, Event Consoles, Configuration Management Database (CMDB), Role-based Administration (RBA), and Web Services. - -[[architecture]] -=== Architecture - -The diagram below describes the capabilities of {product-title}. Its features are designed to work together to provide robust management and maintenance of your virtual infrastructure. -image:1845.png[] - -The architecture comprises the following components: - -* The {product-title} appliance (appliance) which is supplied as a secure, high-performance, preconfigured virtual machine. It provides support for HTTPS communications. -* The {product-title} Server (Server) resides on the appliance. It is the software layer that communicates between the SmartProxy and the Virtual Management Database. -It includes support for HTTPS communications. -* The Virtual Management Database (VMDB) resides either on the appliance or another computer accessible to the appliance. -It is the definitive source of intelligence collected about your Virtual Infrastructure. It also holds status information regarding appliance tasks. -* The {product-title} Console (Console) is the Web interface used to view and control the Server and appliance. -It is consumed through Web 2.0 mash-ups and web services (WS Management) interfaces. -* The SmartProxy can reside on the appliance or on an ESX Server. If not embedded in the Server, the SmartProxy can be deployed from the appliance. -A SmartProxy agent must configured in each storage location, and must be visible to the appliance. The SmartProxy acts on behalf of the appliance communicating with it over HTTPS on standard port 443. - -[[requirements]] -=== Requirements - -To use {product-title}, certain virtual hardware, database, and browser requirements must be met in your environment. - - -[[virtual-hardware-requirements]] -==== Virtual Hardware Requirements - -The {product-title} appliance requires the following virtual hardware at minimum: - -* 4 VCPUs -* 8 GB RAM -* 44 GB HDD + optional database disk - -[[database-requirements]] -==== Database Requirements - -Red Hat recommends allocating the virtual machine disk fully at the time of creation. Three main factors affect the size of your database over time: - -* Virtual Machine Count: the most important factor in the calculation of virtual machine database (VMDB) size over time. -* Host Count: the number of hosts associated with the provider. -* Storage Count: the number of individual storage elements as seen from the perspective of the provider or host. It is not the total number of virtual disks for all virtual machines. - -Use the following table as a guideline to calculate minimum requirements for your database: - -image:5780.png[] - - -[[browser-requirements]] -==== Browser Requirements - -To use {product-title}, the following browser requirements must be met: - -* One of the following web browsers: -** Mozilla Firefox for versions supported under Mozilla's Extended Support Release (ESR) -** Internet Explorer 10 or higher -** Google Chrome for Business -* A monitor with minimum resolution of 1280x1024. -* Adobe Flash Player 9 or above. At the time of publication, you can access it at http://www.adobe.com/products/flashplayer/ - - -[IMPORTANT] -==== -Due to browser limitations, Red Hat supports logging in to only one tab for each multi-tabbed browser. Console settings are saved for the active tab only. For the same reason, {product-title} does not guarantee that the browser's *Back* button will produce the desired results. Red Hat recommends using the breadcrumbs provided in the Console. -==== - -[[additional-requirements]] -==== Additional Requirements - -Additionally, the following must be configured to use {product-title}: - -* The {product-title} appliance must already be installed and activated in your enterprise environment. -* The SmartProxy must have visibility to the virtual machines and cloud instances that you want to control. -* The resources that you want to control must have a SmartProxy associated with them. - - -[[terminology]] -=== Terminology - -The following terms are used throughout this document. Review them before proceeding. - -Account Role:: The level of access a user has to different parts and functions of the {product-title} console. There are a variety of Account Roles, which can be assigned to users to restrict or allow access to parts of the console and virtual infrastructure. - -Action:: An execution that is performed after a condition is evaluated. - -Alert:: {product-title} alerts notify administrators and monitoring systems of critical configuration changes and threshold limits in the virtual environment. -The notification can take the form of either an email or an SNMP trap. - -Analysis Profile:: A customized scan of hosts, virtual machines, or instances. You can collect information from categories, files, event logs, and registry entries. - -Cloud:: A pool of on-demand and highly available computing resources. The usage of these resources are scaled depending on the user requirements and metered for cost. - -{product-title} Appliance:: A virtual machine where the virtual management database (VMDB) and {product-title} reside. - -{product-title} Console:: A web-based interface into the {product-title} appliance. - -{product-title} Role:: A designation assigned to a {product-title} server that defines what a {product-title} server can do. - -{product-title} Server:: The application that runs on the {product-title} appliance and communicates with the SmartProxy and the VMDB. - -Cluster:: Hosts that are grouped together to provide high availability and load balancing. - -Condition:: A control policy test triggered by an event, which determines a subsequent action. - -Discovery:: Process run by the {product-title} server which finds virtual machine and cloud providers. - -Drift:: The comparison of a virtual machine, instance, host, cluster to itself at different points in time. - -Event:: A trigger to check a condition. - -Event Monitor:: Software on the {product-title} appliance which monitors external providers for events and sends them to the {product-title} server. - -Host:: A computer running a hypervisor, capable of hosting and monitoring virtual machines. Supported hypervisors include RHEV-H, VMware ESX hosts, Windows Hyper-V hosts. - -Instance/Cloud Instance:: A on-demand virtual machine based upon a predefined image and uses a scalable set of hardware resources such as CPU, memory, networking interfaces. - -Managed/Registered VM:: A virtual machine that is connected to a host and exists in the VMDB. Also, a template that is connected to a provider and exists in the VMDB. -Note that templates cannot be connected to a host. - -Managed/Unregistered VM:: A virtual machine or template that resides on a repository or is no longer connected to a provider or host and exists in the VMDB. -A virtual machine that was previously considered registered may become unregistered if the virtual machine was removed from provider inventory. - -Provider:: A computer on which software is loaded which manages multiple virtual machines that reside on multiple hosts. - -Policy:: A combination of an event, a condition, and an action used to manage a virtual machine. - -Policy Profile:: A set of policies. - -Refresh:: A process run by the {product-title} server which checks for relationships of the provider or host to other resources, such as storage locations, repositories, virtual machines, or instances. -It also checks the power states of those resources. - -Regions:: Regions are used to create a central database for reporting and charting. Regions are used primarily to consolidate multiple VMDBs into one master VMDB for reporting. - -Resource:: A host, provider, instance, virtual machine, repository, or datastore. - -Resource Pool:: A group of virtual machines across which CPU and memory resources are allocated. - -Repository:: A place on a datastore resource which contains virtual machines. - -SmartProxy:: The SmartProxy is a software agent that acts on behalf of the {product-title} appliance to perform actions on hosts, providers, storage and virtual machines. - -:: The SmartProxy can be configured to reside on the {product-title} appliance or on an ESX server version. -The SmartProxy can be deployed from the {product-title} appliance, and provides visibility to the VMFS storage. Each storage location must have a SmartProxy with visibility to it. -The SmartProxy acts on behalf of the {product-title} appliance. If the SmartProxy is not embedded in the {product-title} server, it communicates with the {product-title} appliance over HTTPS on standard port 443. - -SmartState Analysis:: Process run by the SmartProxy which collects the details of a virtual machine or instance. Such details include accounts, drivers, network information, hardware, and security patches. This process is also run by the {product-title} server on hosts and clusters. The data is stored in the VMDB. - -SmartTags:: Descriptors that allow you to create a customized, searchable index for the resources in your clouds and infrastructure. - -Storage Location:: A device, such as a VMware datastore, where digital information resides that is connected to a resource. - -Tags:: Descriptive terms defined by a {product-title} user or the system used to categorize a resource. - -Template:: A template is a copy of a preconfigured virtual machine, designed to capture installed software and software configurations, as well as the hardware configuration, of the original virtual machine. - -Unmanaged Virtual Machine:: Files discovered on a datastore that do not have a virtual machine associated with them in the VMDB. -These files may be registered to a provider that the {product-title} server does not have configuration information on. -Possible causes may be that the provider has not been discovered or that the provider has been discovered, but no security credentials have been provided. - -Virtual Machine:: A software implementation of a system that functions similar to a physical machine. -Virtual machines utilize the hardware infrastructure of a physical host, or a set of physical hosts, to provide a scalable and on-demand method of system provisioning. - -Virtual Management Database (VMDB):: Database used by the {product-title} appliance to store information about your resources, users, and anything else required to manage your virtual enterprise. - -Virtual Thumbnail:: An image in the web interface representing a resource, such as a provider or a virtual machine, showing the resource's properties at a glance. Each virtual thumbnail is divided into quadrants, which provide information about the resource, such as its software and power state. - -Zones:: {product-title} Infrastructure can be organized into zones to configure failover and to isolate traffic. Zones can be created based on your environment. -Zones can be based on geographic location, network location, or function. When first started, new servers are put into the default zone. - -ifdef::cfme[] -[[getting-support]] -=== Getting Support - -If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at http://access.redhat.com. Through the Customer Portal, you can: - -* search or browse through a knowledgebase of technical support articles about Red Hat products -* submit a support case to Red Hat Global Support Services (GSS) -* access other product documentation - -Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. -You can find a list of publicly available mailing lists at https://www.redhat.com/mailman/listinfo. Click on the name of any mailing list to subscribe to that list or to access the list archives. -endif::cfme[] - - - diff --git a/doc-Configuring_High_Availability/cfme/common/openstack/adding-an-openstack-cloud-provider.adoc b/doc-Configuring_High_Availability/cfme/common/openstack/adding-an-openstack-cloud-provider.adoc deleted file mode 100644 index 6dff19807..000000000 --- a/doc-Configuring_High_Availability/cfme/common/openstack/adding-an-openstack-cloud-provider.adoc +++ /dev/null @@ -1,63 +0,0 @@ -{product-title} supports operating with the OpenStack `admin` tenant. -When creating an OpenStack provider in {product-title}, select the OpenStack provider's `admin` user because it is the default administrator of the OpenStack `admin` tenant. -When using the `admin` credentials, a user in {product-title} provisions into the `admin` tenant, and sees images, networks, and instances that are associated with the `admin` tenant. - -[NOTE] -===== -include::tenant-mapping.adoc[] -===== - -[NOTE] -===== -You can set whether {product-title} should use the Telemetry service or Advanced Message Queueing Protocol (AMQP) for event monitoring. If you choose Telemetry, you should first configure the *ceilometer* service on the overcloud to store events. See xref:openstack-events-oc[] for instructions. - -For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-telemetry[OpenStack Telemetry (ceilometer)] in the Red Hat OpenStack Platform _Architecture Guide_. -===== - -. Navigate to menu:Compute[Clouds > Providers]. - -. Click image:1847.png[] (*Configuration*), then click image:1848.png[] (*Add a New Cloud Provider*). - -. Enter a *Name* for the provider. - -. From the *Type* drop down menu select *OpenStack*. - -. Select the appropriate *API Version* from the list. The default is `Keystone v2`. -+ -If you select `Keystone v3`, enter the `Keystone V3 Domain ID` that {product-title} should use. This is the domain of the user account you will be specifying later in the *Default* tab. If domains are not configured in the provider, enter *default*. -+ -[NOTE] -========= -include::osp-keystone-api-v3.adoc[] -========= - -. By default, _tenant mapping_ is disabled. To enable it, set *Tenant Mapping Enabled* to *Yes*. - -. Select the appropriate *Zone* for the provider. By default, the zone is set to *default*. -+ -NOTE: For more information, see the definition of host aggregates and availability zones in https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-compute[OpenStack Compute (nova)] in the Red Hat OpenStack Platform _Architecture Guide_. - -. In the *Default* tab, under *Endpoints*, configure the host and authentication details of your OpenStack provider: -.. In *Hostname (or IPv4 or IPv6 address)*, enter the public IP or fully qualified domain name of the OpenStack Keystone service. -+ -NOTE: The hostname required here is also the *OS_AUTH_URL* value in the *~/overcloudrc* file generated by the director (see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#sect-Accessing_the_Overcloud[Accessing the Overcloud] in Red Hat OpenStack Platform _Director Installation and Usage_ or the *~/keystonerc_admin* file generated by Packstack (see https://access.redhat.com/articles/1127153[Evaluating OpenStack: Single-Node Deployment]). -.. In *API Port*, set the public port used by the OpenStack Keystone service. By default, OpenStack uses port 5000 for this. -.. Select the appropriate *Security Protocol* used for authenticating with your OpenStack provider. -.. In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -.. Click *Validate* to confirm {product-title} can connect to the OpenStack provider. - -. Next, configure how {product-title} should receive events from the OpenStack provider. Click the *Events* tab in the *Endpoints* section to start. -* To use the Telemetry service of the OpenStack provider, select *Ceilometer*. Before you do so, the provider must first be configured accordingly. See xref:openstack-events-oc[] for details. -* If you prefer to use the AMQP Messaging bus instead, select *AMQP*. When you do: - In *Hostname (or IPv4 or IPv6 address)* (of the *Events* tab, under *Endpoints*), enter the public IP or fully qualified domain name of the AMQP host. -** In the *API Port*, set the public port used by AMQP. By default, OpenStack uses port 5672 for this. -** In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -** Click *Validate* to confirm the credentials. - -. Click *Add* after configuring the cloud provider. - -[NOTE] -==== -To collect inventory and metrics from an OpenStack environment, the {product-title} appliance requires that the adminURL endpoint for the OpenStack environment be on a non-private network. -Hence, the OpenStack adminURL endpoint should be assigned an IP address other than `192.168.x.x`. Additionally, all the Keystone endpoints must be accessible, otherwise refresh will fail. -==== diff --git a/doc-Configuring_High_Availability/cfme/common/openstack/adding-an-openstack-infrastructure-provider.adoc b/doc-Configuring_High_Availability/cfme/common/openstack/adding-an-openstack-infrastructure-provider.adoc deleted file mode 100644 index a5e8cf22b..000000000 --- a/doc-Configuring_High_Availability/cfme/common/openstack/adding-an-openstack-infrastructure-provider.adoc +++ /dev/null @@ -1,57 +0,0 @@ -After initial installation and creation of a {product-title} environment, add an OpenStack infrastructure provider to the appliance. {product-title} supports operating with the OpenStack `admin` tenant. -When creating an OpenStack infrastructure provider in {product-title}, select the OpenStack infrastructure provider's `admin` user because it is the default administrator of the OpenStack `admin` tenant. -When using the `admin` credentials, a user in {product-title} provisions into the `admin` tenant, and sees images, networks, and instances that are associated with the `admin` tenant. - -[NOTE] -===== -You can set whether {product-title} should use the Telemetry service or Advanced Message Queueing Protocol (AMQP) for event monitoring. If you choose Telemetry, you should first configure the *ceilometer* service on the undercloud to store events. See xref:openstack-events-uc[] for instructions. - -For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-telemetry[OpenStack Telemetry (ceilometer)] in the Red Hat OpenStack Platform _Architecture Guide_. -===== - - -. Navigate to menu:Compute[Infrastructure > Providers]. -. Click image:1847.png[Configuration] (*Configuration*), then click image:1862.png[Add a New Infrastructure Provider] (*Add a New Infrastructure Provider*). -. Enter the *Name* of the provider to add. - The *Name* is how the device is labeled in the console. -. Select *OpenStack Platform Director* from the *Type* list. - -. Select the *API Version* of your OpenStack provider's Keystone service from the list. The default is `Keystone v2`. -+ -[NOTE] -========= -include::osp-keystone-api-v3.adoc[] -========= - -. Select the appropriate *Zone* for the provider. By default, the zone is set to *default*. -+ -NOTE: For more information, see the definition of host aggregates and availability zones in https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-compute[OpenStack Compute (nova)] in the Red Hat OpenStack Platform _Architecture Guide_. - -. In the *Default* tab, under *Endpoints*, configure the host and authentication details of your OpenStack provider: -.. Enter the *Host Name or IP address(IPv4 or IPv6)* of the provider. If your provider is an undercloud, use its hostname (see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#sect-Setting_the_Hostname_for_the_System[Setting the Hostname for the System] in Red Hat OpenStack Platform _Director Installation and Usage_ for more details) -.. In *API Port*, set the public port used by the OpenStack Keystone service. By default, OpenStack uses port 5000 for this. -.. Select the appropriate *Security Protocol* used for authenticating with your OpenStack provider. -.. In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -.. Click *Validate* to confirm {product-title} can connect to the OpenStack provider. - -. Next, configure how {product-title} should receive events from the OpenStack provider. Click the *Events* tab in the *Endpoints* section to start. -* To use the Telemetry service of the OpenStack provider, select *Ceilometer*. Before you do so, the provider must first be configured accordingly. See xref:openstack-events-uc[] for details. -* If you prefer to use the AMQP Messaging bus instead, select *AMQP*. When you do: - In *Hostname (or IPv4 or IPv6 address)* (of the *Events* tab, under *Endpoints*), enter the public IP or fully qualified domain name of the AMQP host. -** In the *API Port*, set the public port used by AMQP. By default, OpenStack uses port 5672 for this. -** In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -** Click *Validate* to confirm the credentials. - -. You can also configure SSH access to all hosts managed by the OpenStack infrastructure provider. To do so, click on the *RSA key pair* tab in the *Endpoints* section. -.. From there, enter the *Username* of an account with privileged access. -.. If you selected *SSL* in *Endpoints > Default > Security Protocol* earlier, use the *Browse* button to find and set a private key. - -. Click *Add* after configuring the infrastructure provider. - - -[NOTE] -==== -{product-title} requires that the `adminURL` endpoint for all OpenStack services be on a non-private network. -Accordingly, assign the adminURL endpoint an IP address of something other than `192.168.x.x`. -The `adminURL` endpoint must be accessible to the {product-title} appliance that is responsible for collecting inventory and gathering metrics from the OpenStack environment. Additionally, all the Keystone endpoints must be accessible, otherwise refresh will fail. -==== diff --git a/doc-Configuring_High_Availability/cfme/common/openstack/configure-overcloud-to-store-events.adoc b/doc-Configuring_High_Availability/cfme/common/openstack/configure-overcloud-to-store-events.adoc deleted file mode 100644 index ebad6d06c..000000000 --- a/doc-Configuring_High_Availability/cfme/common/openstack/configure-overcloud-to-store-events.adoc +++ /dev/null @@ -1,52 +0,0 @@ -By default, the Telemetry service does not store events emitted by other services in a Red Hat OpenStack Platform environment. The following procedure outlines how to enable the Telemetry service on your OpenStack cloud provider to store such events. This ensures that events are exposed to {product-title} when a Red Hat OpenStack Platform environment is added as a cloud provider. - -// . On the director node, edit _undercloud.conf_, and set _store_events_ to _true_. -. Log in to the undercloud host. -. Create an environment file called _ceilometer.yaml_, and add the following contents: -+ ------- -parameter_defaults: - CeilometerStoreEvents: true ------- -+ -. Add the environment file to the _overcloud deploy_ command: -+ ------- -# openstack overcloud deploy --templates -e ~/ceilometer.yaml ------- - -If your OpenStack cloud provider was not deployed through the undercloud, you can also set this manually. To do so: - -. Log in to your Controller node. -. Edit _/etc/ceilometer/ceilometer.conf_, and specify the following option: -+ ------- -store_events = True ------- -+ -. Edit _/etc/heat/heat.conf_, and specify the following options: -+ ------- -notification_driver=glance.openstack.common.notifier.rpc_notifier -notification_topics=notifications ------- -+ -. Edit _/etc/nova/nova.conf_, and specify the following options: -+ ------- -notification_driver=messaging -notification_topics=notifications ------- -+ -. Restart the Compute service and Orchestration services: -+ ------- -# systemctl restart openstack-heat-api.service \ - openstack-heat-api-cfn.service \ - openstack-heat-engine.service \ - openstack-heat-api-cloudwatch.service ------- -+ ------- -# systemctl restart openstack-nova-compute.service ------- diff --git a/doc-Configuring_High_Availability/cfme/common/openstack/configure-undercloud-to-store-events.adoc b/doc-Configuring_High_Availability/cfme/common/openstack/configure-undercloud-to-store-events.adoc deleted file mode 100644 index 61a5e5f4d..000000000 --- a/doc-Configuring_High_Availability/cfme/common/openstack/configure-undercloud-to-store-events.adoc +++ /dev/null @@ -1 +0,0 @@ -To allow {product-title} to receive events from a Red Hat OpenStack Platform environment, you must configure the *notification_driver* option for the Compute service and Orchestration service in that environment. To do so, edit _undercloud.conf_, and set _store_events_ to _true_ before installing the undercloud. See https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#chap-Installing_the_Undercloud[Installing the Undercloud] and https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#sect-Configuring_the_Director[Configuring the Director] in Red Hat OpenStack Platform _Director Installation and Usage_ for related details. diff --git a/doc-Configuring_High_Availability/cfme/common/openstack/osp-keystone-api-v3.adoc b/doc-Configuring_High_Availability/cfme/common/openstack/osp-keystone-api-v3.adoc deleted file mode 100644 index d8c7baaf8..000000000 --- a/doc-Configuring_High_Availability/cfme/common/openstack/osp-keystone-api-v3.adoc +++ /dev/null @@ -1 +0,0 @@ -With Keystone API v3, domains are used to determine administrative boundaries of service entities in OpenStack. Domains allow you to group users together for various purposes, such as setting domain-specific configuration or security options. For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-identity[OpenStack Identity (keystone)] in the Red Hat OpenStack Platform _Architecture Guide_. diff --git a/doc-Configuring_High_Availability/cfme/common/openstack/tenant-mapping.adoc b/doc-Configuring_High_Availability/cfme/common/openstack/tenant-mapping.adoc deleted file mode 100644 index 338bcdbd3..000000000 --- a/doc-Configuring_High_Availability/cfme/common/openstack/tenant-mapping.adoc +++ /dev/null @@ -1,3 +0,0 @@ -When adding an OpenStack cloud or infrastructure provider, you can enable _tenant mapping_ in {product-title} to map any existing tenants from that provider. This means {product-title} will create new cloud tenants to match each of existing OpenStack tenants; each new cloud tenant and its corresponding OpenStack tenant will have identical user memberships, quotas, access/security rules, and resources assignments. - -During a provider refresh, {product-title} will also check for any changes to the tenant list in OpenStack. {product-title} will create new cloud tenants to match any new tenants, and delete any cloud tenants whose corresponding OpenStack tenants no longer exist. {product-title} will also replicate any changes to OpenStack tenants to their corresponding cloud tenants. diff --git a/doc-Configuring_High_Availability/cfme/common/osp-keystone-api-v3.adoc b/doc-Configuring_High_Availability/cfme/common/osp-keystone-api-v3.adoc deleted file mode 100644 index d8c7baaf8..000000000 --- a/doc-Configuring_High_Availability/cfme/common/osp-keystone-api-v3.adoc +++ /dev/null @@ -1 +0,0 @@ -With Keystone API v3, domains are used to determine administrative boundaries of service entities in OpenStack. Domains allow you to group users together for various purposes, such as setting domain-specific configuration or security options. For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-identity[OpenStack Identity (keystone)] in the Red Hat OpenStack Platform _Architecture Guide_. diff --git a/doc-Configuring_High_Availability/cfme/common/policies-assigning-profiles-to-infra-hosts.adoc b/doc-Configuring_High_Availability/cfme/common/policies-assigning-profiles-to-infra-hosts.adoc deleted file mode 100644 index b96b4ec87..000000000 --- a/doc-Configuring_High_Availability/cfme/common/policies-assigning-profiles-to-infra-hosts.adoc +++ /dev/null @@ -1,9 +0,0 @@ -. Navigate to menu:Compute[Infrastructure > Providers], verify the provider you need to assign the policy profiles to. - -. Click image:../images/1941.png[image] (*Policy*), and then click image:../images/1851.png[image](*Manage Policies*). - -. From the *Select Policy Profiles* area, you can click on the triangle next to a desired policy profile to expand it and see its member policies. - -. Check the policy profiles you require to apply to the provider. It turns blue to show its assignment state has changed. - -. Click *Save*. diff --git a/doc-Configuring_High_Availability/cfme/common/policies-creating-profiles.adoc b/doc-Configuring_High_Availability/cfme/common/policies-creating-profiles.adoc deleted file mode 100644 index aae8d67d0..000000000 --- a/doc-Configuring_High_Availability/cfme/common/policies-creating-profiles.adoc +++ /dev/null @@ -1,19 +0,0 @@ -. Navigate to menu:Control[Explorer]. - -. Click on the *Policy Profiles* accordion, then click image:../images/1847.png[image] (*Configuration*), then image:../images/1862.png[image] (*Add a New Policy Profile*). - -. In the *Basic Information* area, type in a unique description for the policy profile. -+ -image:../images/1931.png[image] - -. From *Available Policies* in the *Policy Selection* area select all the policies you need to apply to this policy profile. Use the `Ctrl` key to select multiple policies. -+ -image:../images/1930.png[image] - -. Click image:../images/1876.png[image] to add the *Policies*. -+ -image:../images/1929.png[image] - -. Add to the *Notes* area if required. - -. Click *Add*. diff --git a/doc-Configuring_High_Availability/cfme/common/policies-creating-vm-control-policy.adoc b/doc-Configuring_High_Availability/cfme/common/policies-creating-vm-control-policy.adoc deleted file mode 100644 index ebfa06f91..000000000 --- a/doc-Configuring_High_Availability/cfme/common/policies-creating-vm-control-policy.adoc +++ /dev/null @@ -1,33 +0,0 @@ -. Navigate to menu:Control[Explorer]. -. Expand the *Policies* accordion, and click *Control Policies*. -. Select *Vm Control Policies*. -. Click image:../images/1847.png[image] (*Configuration*), then image:../images/1862.png[image] (*Add a New VM and Instance Control Policy*). -. Enter a *Description*. This will be the name given to your VM control policy. -. Uncheck *Active* if you do not want this policy processed even when assigned to a resource. -. Optionally, enter *Scope* (you can also create a scope as part of a condition, or not use one at all). If the virtual machine is not included in the scope, the assigned action will not run. -+ -You can use the drop-down below the image:../images/1863.png[image] (*Commit expression element changes*) icon to create an expression for the *Scope*. {product-title_short} will generate drop-downs containing relevant options depending on your choices. Click image:../images/1863.png[image] (*Commit expression element changes*) to add the scope. - - - -. Enter *Notes* if required. -. Click *Add*. The policy is added and listed under *Vm Control Policies* in the *Policies* accordion. -. Select the newly-added VM control policy. You can now associate events, conditions, and actions with the policy. -. Click image:../images/1847.png[image] (*Configuration*), then image:../images/1851.png[image] (*Edit this Policy’s Event assignments*). -. Under *VM Operation*, select *VM Analysis Start*. -. Click *Save*. -. Click the *VM Analysis Start* event to configure actions. -. Click image:../images/1847.png[image] (*Configuration*), then image:../images/1851.png[image] (*Edit Actions for this Policy Event*). -. In *Order of Actions if ALL Conditions are True*, select the action created in xref:assign-profile-analysis-task-action[] from the *Available Actions* list. This action will take place if the resources meet the conditions of the policy. -+ -image:../images/edit-action.png[image] -+ -[NOTE] -==== -Each selected action can be executed synchronously or asynchronously; a synchronous action will not start until the previous synchronous action is completed, while an asynchronous action allows the next action to start whether or not the first action has completed. Also, at least one {product-title} server in the {product-title} zone must have the notifier server role enabled for the trap to be sent. -==== -+ -. Click (image:../images/1876.png[image]) which will move the action to *Selected Actions*. The selected action is set to (S) Synchronous by default. From *Selected Actions*, select the action, then: -* Click *A* (Set selected Actions to Asynchronous) to make it asynchronous. -* Click *S* (Set selected Actions to Synchronous) to make it synchronous. If creating a synchronous action, use the up and down arrows to identify in what order you want the actions to run. -. Click *Save*. diff --git a/doc-Configuring_High_Availability/cfme/common/policies-intro.adoc b/doc-Configuring_High_Availability/cfme/common/policies-intro.adoc deleted file mode 100644 index e9a39042a..000000000 --- a/doc-Configuring_High_Availability/cfme/common/policies-intro.adoc +++ /dev/null @@ -1,15 +0,0 @@ -Policies are used to manage your virtual environment. There are two -types of policies available: compliance and control. Compliance policies -are used to harden your virtual infrastructure, making sure that your -security requirements are adhered to. Control policies are used to check -for a specific condition and perform an action based on the outcome. For -example: - -* Prevent virtual machines from running without an administrator -account. -* Prevent virtual machines from starting if certain patches are not -applied. -* Configure the behavior of a production virtual machine to only start -if it is running on a production host. -* Force a SmartState Analysis when a host is added or removed from a -cluster. diff --git a/doc-Configuring_High_Availability/cfme/common/provider-ose-add-container.adoc b/doc-Configuring_High_Availability/cfme/common/provider-ose-add-container.adoc deleted file mode 100644 index 8ba45756b..000000000 --- a/doc-Configuring_High_Availability/cfme/common/provider-ose-add-container.adoc +++ /dev/null @@ -1,17 +0,0 @@ -. Navigate to menu:Compute[Containers > Providers]. -. Click image:1847.png[Configuration] (*Configuration*), then click image:1862.png[Add a New Containers Provider] (*Add a New Containers Provider*). -. Enter a *Name* for the provider. -. From the *Type* list, select *OpenShift Enterprise*. -. Enter the appropriate *Zone* for the provider. By default, the zone is set to `default`. -. Enter the *Hostname or IP address* of the provider. -+ -[IMPORTANT] -==== -The *Hostname* must use a unique fully qualified domain name. -==== -+ -. Enter the *Port* of the provider. - The default port is `8443`. -. Under *Credentials*, enter the token in the *Token* field. This is the token obtained earlier in xref:Obtaining_OpenShift_Enterprise_Management_Token[]. -* Click *Validate* to confirm that the {product-title} can connect to the OpenShift Enterprise provider using the provided token. -. Click *Add*. diff --git a/doc-Configuring_High_Availability/cfme/common/provider-ose-mgt-token-3_1.adoc b/doc-Configuring_High_Availability/cfme/common/provider-ose-mgt-token-3_1.adoc deleted file mode 100644 index 405f0d208..000000000 --- a/doc-Configuring_High_Availability/cfme/common/provider-ose-mgt-token-3_1.adoc +++ /dev/null @@ -1,18 +0,0 @@ -Open a terminal and perform the following: - -. To obtain the `management` service account token name, run the following command:: - - # oc describe sa -n management-infra management-admin - ... - Tokens: management-admin-token-0f3fh - management-admin-token-q7a87 - -. Select one of the tokens and run the following command to retrieve the full token output: - - # oc describe secret -n management-infra management-admin-token-0f3fh - ... - Data - ==== - token: eyJhbGciOiJSUzI1NiI... -+ -Replace `management-admin-token-0f3fh` with the name of your token. diff --git a/doc-Configuring_High_Availability/cfme/common/provider-ose-mgt-token-3_2.adoc b/doc-Configuring_High_Availability/cfme/common/provider-ose-mgt-token-3_2.adoc deleted file mode 100644 index 371120ec7..000000000 --- a/doc-Configuring_High_Availability/cfme/common/provider-ose-mgt-token-3_2.adoc +++ /dev/null @@ -1,4 +0,0 @@ -Open a terminal and run the following command: - - # oc sa get-token -n management-infra management-admin - eyJhbGciOiJSUzI1NiI... diff --git a/doc-Configuring_High_Availability/cfme/common/provisioning-dialogs-customization.adoc b/doc-Configuring_High_Availability/cfme/common/provisioning-dialogs-customization.adoc deleted file mode 100644 index e8f40c026..000000000 --- a/doc-Configuring_High_Availability/cfme/common/provisioning-dialogs-customization.adoc +++ /dev/null @@ -1,11 +0,0 @@ -The default set of provisioning dialogs shows all possible options. However, {product-title} also provides the ability to customize which tabs and fields are shown. You can decide what fields are required to submit the provisioning request or set default values. - -For each type of provisioning, there is a dialog that can be created to adjust what options are presented. While samples are provided containing all possible fields for provisioning, you can remove what fields are shown. However, you cannot add fields or tabs. - -Edit the dialogs to: - -. Hide or show provisioning tabs. -. Hide or show fields. If you hide an attribute, the default will be used, unless you specify otherwise. -. Set default values for a field. -. Specify if a field is required to submit the request. -. Create custom dialogs for specific users. diff --git a/doc-Configuring_High_Availability/cfme/common/provisioning-requests-keypairs.adoc b/doc-Configuring_High_Availability/cfme/common/provisioning-requests-keypairs.adoc deleted file mode 100644 index 38381fe3c..000000000 --- a/doc-Configuring_High_Availability/cfme/common/provisioning-requests-keypairs.adoc +++ /dev/null @@ -1,21 +0,0 @@ - -Key pairs allow you to manage SSH access between a user and provisioned instance. For more information about key pairs in OpenStack, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/instances-and-images-guide/chapter-3-virtual-machine-instances#section-manage-keypair[Manage Key Pairs] from the https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/instances-and-images-guide/instances-and-images-guide[Red Hat OpenStack Platform Instances and Images Guide]. - -To manage key pairs, navigate to menu:Compute[Clouds > Key Pairs]. From there, you can view a list of available key pairs. Click on a key pair to view its details. - -To create a new key pair: - -. Navigate to menu:Compute[Clouds > Key Pairs]. - -. Click image:1847.png[](*Configuration*), image:2345.png[](*Add a new Key Pair*). - -. Enter a *Name* for the key pair. - -. If you want to use a public key, copy its contents into the *Public Key (optional)* field. - -. Select which cloud provider on which to create the key pair. The key pair will then be available for use by instances in that provider. - -. Click *Add*. - -// ddomingo -// TODO: NEED TO add steps for using keypair info for streamlining SSH access to instance that uses a keypair. When creating a keypair in OpenStack, a downloadable PEM key is created that you can immediately use in accessing the instance via SSH. No such PEM key is made available when creating key pairs via CFME. diff --git a/doc-Configuring_High_Availability/cfme/common/provisioning-requests-openstack.adoc b/doc-Configuring_High_Availability/cfme/common/provisioning-requests-openstack.adoc deleted file mode 100644 index e75f51401..000000000 --- a/doc-Configuring_High_Availability/cfme/common/provisioning-requests-openstack.adoc +++ /dev/null @@ -1,53 +0,0 @@ - -. Navigate to menu:Compute[Clouds > Instances]. - -. Click image:2007.png[](*Lifecycle*), then click image:1862.png[](*Provision Instances*). - -. Select an OpenStack image from the list presented. These images must be available on your OpenStack provider. - -. Click *Continue*. - -. On the *Request* tab, enter information about this provisioning request. In *Request Information*, type in at least a first and last name and an email address. This email is used to send the requester status emails during the provisioning process for items such as auto-approval, quota, provision complete, retirement, request pending approval, and request denied. The other information is optional. If the {product-title} Server is configured to use LDAP, you can use the *Look Up* button to populate the other fields based on the email address. -+ -[NOTE] -==== -Parameters with a * next to the label are required to submit the provisioning request. To change the required parameters, see xref:provisioning-dialogs-customizing[]. -==== -+ -. Click the *Purpose* tab to select the appropriate tags for the provisioned instance. -. Click the *Catalog* tab for basic instance options. -.. To change the image to use as a basis for the instance, select it from the list of images. -.. Select the *Number of Instances* to provision. -.. Type a *Instance Name* and *Instance Description*. - -. Click the *Environment* tab to select the instance's *Tenant*, *Availabilty Zones*, *Cloud Network*, *Security Groups*, and *Public IP Address*. If no specific Tenant is required, select the *Choose Automatically* checkbox. - -. Click the *Properties* tab to set provider options such as flavors and security settings. -.. Select a flavor from the *Instance Type* list. -.. Select a *Guest Access Key Pair* for access to the instance. For more information about key pairs, see xref:provision-keypairs[]. - -. Click the *Volumes* tab to provision any volumes with the instance. Volumes are useful for augmenting ephemeral storage of instances with persistent, general-purpose block storage: -.. Fill in the *Volume Name* and *Size (gigabytes)* fields. -.. If you want the volume to be deleted once the instance terminates (thereby making it non-persistent), check *Delete on Instance Terminate*. -.. To provision and add multiple volumes to the instance, click *Add Volume*. Doing so will add new fields you can fill in. -+ -For more information about persistent storage in OpenStack, see the Red Hat OpenStack Platform _Storage Guide_. - -. Click the *Customize* tab to set additional instance options. -.. Under *Credentials*, enter a *Root Password* for the *root* user access to the instance. -.. Enter a *IP Address Information* for the instance. Leave as *DHCP* for automatic IP assignment from the provider. -.. Enter any *DNS* information for the instance if necessary. -.. Select a *Customize Template* for additional instance configuration. Select from the Cloud-Init scripts stored on your appliance. -. Click the *Schedule* tab to set the provisioning and retirement date and time. -.. In *Schedule Info*, choose whether the provisioning begins upon approval, or at a specific time. If you select *Schedule*, you will be prompted to enter a date and time. -.. In *Lifespan*, select whether to power on the instances after they are created, and whether to set a retirement date. If you select a retirement period, you will be prompted for when to receive a retirement warning. -. Click *Submit*. - -The provisioning request is sent for approval. For the provisioning to begin, a user with the admin, approver, or super admin account role must approve the request. The admin and super admin roles can also edit, delete, and deny the requests. You will be able to see all provisioning requests where you are either the requester or the approver. - -After submission, the appliance assigns each provision request a *Request ID*. If an error occurs during the approval or provisioning process, use this ID to locate the request in the appliance logs. The Request ID consists of the region associated with the request followed by the request number. As regions define a range of one trillion database IDs, this number can be several digits long. - -*Request ID Format* - -Request 99 in region 123 results in Request ID 123000000000099. - diff --git a/doc-Configuring_High_Availability/cfme/common/reports-categories.adoc b/doc-Configuring_High_Availability/cfme/common/reports-categories.adoc deleted file mode 100644 index dafe1bbae..000000000 --- a/doc-Configuring_High_Availability/cfme/common/reports-categories.adoc +++ /dev/null @@ -1,16 +0,0 @@ -* *Configuration Management*: hardware, application, network, service, user account, operating system, and snapshot information for all of your items. -* *Migration Readiness*: information related to items required to migrate a virtual machine. -* *Operations*: free space on registered and unregistered virtual machines, power states for virtual machines, and SmartState analysis status. -+ -This category also provides reports relating to the operation of {product-title}, such as user IDs and snapshots taken by {product-title}. -* *VM Sprawl*: usage information and disk waste. -* *Relationships*: virtual machine, folder, and cluster relationships. -* *Events*: operations and configuration management events. -* *Performance by Asset Type*: performance of your virtual infrastructure. -+ -You must be capturing capacity and utilization data to get this information. -* *Running Processes*: information on processes running on a virtual machine. -+ -You must have domain credentials entered for the zone to collect the info for these reports, and the virtual machine must have been analyzed at least once. -* *Trending*: projections of datastore capacity, along with host CPU and memory use. -* *Provisioning*: provisioning activity based on the approver, datastore, requester, and virtual machine. diff --git a/doc-Configuring_High_Availability/cfme/common/reports-generate-single.adoc b/doc-Configuring_High_Availability/cfme/common/reports-generate-single.adoc deleted file mode 100644 index ca1b9cef1..000000000 --- a/doc-Configuring_High_Availability/cfme/common/reports-generate-single.adoc +++ /dev/null @@ -1,8 +0,0 @@ -. Navigate to menu:Cloud Intel[Reports] -. Click the *Reports* accordion and select the report you want to view. -. Click image:1847.png[] (*Queue*). -. The report generation is placed on the queue and its status shows in the reports page. -+ -image:2274.png[] -. Click image:2106.png[] *(Reload current display)* to update the status. -. When a report has finished generating, click on its row to view it. diff --git a/doc-Configuring_High_Availability/cfme/common/service-dialog-creation.adoc b/doc-Configuring_High_Availability/cfme/common/service-dialog-creation.adoc deleted file mode 100644 index be360b773..000000000 --- a/doc-Configuring_High_Availability/cfme/common/service-dialog-creation.adoc +++ /dev/null @@ -1,76 +0,0 @@ -. Navigate to menu:Automate[Customization]. -. Click the *Service Dialogs* accordion. -. Click image:1847.png[](*Configuration*), and then image:1862.png[](*Add a new Dialog*). -. In *Dialog Information*, type in a *Label* and *Description*. Check the boxes for the buttons you want available at the bottom of the dialog form. The description will appear as hover text. -+ -As you type in the *Label* of the dialog, it should appear in the *Dialog* pane on the left. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Tab to this Dialog*). -.. Type in a *Label* and *Description* for this tab. -+ -As you type in the *Label* of the tab, it should appear in the *Dialog* pane on the left under the dialog you are creating. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Box to this Tab*). -.. Type in a *Label* and *Description* for this box. -+ -As you type in the *Label* of the box, it should appear in the *Dialog* pane on the left under the tab you are creating. -. Add an element to this box. Elements are controls that accept input. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Element to this Box*). -.. Type in a *Label*, *Name*, and *Description* for this element. -+ -[IMPORTANT] -==== -*Name* must use only alphanumeric characters and underscores without spaces. It is also used to retrieve the value of this element in the method used with the dialog and must start with *dialog_service_type* -==== -+ -.. Select a *Type* for an element type. All *Type* options have a *Required* and *Default Value* field. Check *Required* or set *Required* to *true* if the element is required to proceed. You can also specify a default value. The rest of the options presented are based on which type of element you select. -+ -[width="100%",cols="40%,60%",options="header",] -|==== -|Element Types|Additional Info -|Check Box|Check *Default Value* if you want this check box checked by default. -|Date Control|Use *Date Control* to create a field where users can select a date. If you want users to be able to select a date and time, use the *Date/Time Control* option. -|Date/Time Control|Use *Date/Time Control* to create a field where users can select a date and time. Only one *Date Control* or *Date/Time Control* element can be present in a dialog. -|Drop Down Dynamic List|Use *Drop Down Dynamic List* if you want the list options to be created using automate methods. Use *Entry Point (NS/Cls/Inst)* to select an automate instance. Check *Show Refresh Button* to allow users to refresh the list options manually. -|Radio Button|This element type serves the same purpose as *Drop Down List* but displays options using radio buttons. -|Tag Control|Select a *Category* of tags you want assigned to the virtual machines associated with this service dialog. Check *Single Select* if only one tag can be selected. -|Text Area Box|Provides text area for users to type in some text. You can also leave a message to users by typing in the *Default Value* field or leave it as blank. -|Text Box|This element type serves the same purpose as *Text Area Box* with the option to check *Protected* so the text is shown as asterisks (*), instead of plain text. -|==== -+ -. Continue adding the dialog items you need. You can switch between dialogs, tabs, boxes, and elements by selecting their respective labels from the *Dialog* pane on the left. -. Click *Add*. Your dialog should appear in the *Service Dialogs* accordion. - -///////////////////////////////// -. Select the dialog you just created. -. Click image:1847.png[](*Configuration*), and then image:1851.png[](*Edit this Dialog*). -. Add a tab to the dialog. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Tab to this Dialog*). -.. Type in a *Label* and *Description* for this tab. -. Add a box to this tab. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Box to this Tab*). -.. Type in a *Label* and *Description* for this box. -. Add an element to this box. Elements are controls that accept input. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Element to this Box*). -.. Type in a *Label*, *Name*, and *Description* for this element. -+ -[IMPORTANT] -==== -*Name* must use only alphanumeric characters and underscores without spaces. It is also used to retrieve the value of this element in the method used with the dialog and must start with *dialog_service_type* -==== -+ -.. Select a *Type* for an element type. All *Type* options have a *Required* and *Default Value* field. Check *Required* or set *Required* to *true* if the element is required to proceed. You can also specify a default value. The rest of the options presented are based on which type of element you select. -+ -[width="100%",cols="40%,60%",options="header",] -|==== -|Element Types|Additional Info -|Check Box|Check *Default Value* if you want this check box checked by default. -|Date Control|Use *Date Control* to create a field where users can select a date. If you want users to be able to select a date and time, use the *Date/Time Control* option. -|Date/Time Control|Use *Date/Time Control* to create a field where users can select a date and time. Only one *Date Control* or *Date/Time Control* element can be present in a dialog. -|Drop Down Dynamic List|Use *Drop Down Dynamic List* if you want the list options to be created using automate methods. Use *Entry Point (NS/Cls/Inst)* to select an automate instance. Check *Show Refresh Button* to allow users to refresh the list options manually. -|Radio Button|This element type serves the same purpose as *Drop Down List* but displays options using radio buttons. -|Tag Control|Select a *Category* of tags you want assigned to the virtual machines associated with this service dialog. Check *Single Select* if only one tag can be selected. -|Text Area Box|Provides text area for users to type in some text. You can also leave a message to users by typing in the *Default Value* field or leave it as blank. -|Text Box|This element type serves the same purpose as *Text Area Box* with the option to check *Protected* so the text is shown as asterisks (*), instead of plain text. -|==== -+ -. Click *Save*. -///////////////////////////////// diff --git a/doc-Configuring_High_Availability/cfme/common/smartstate-analysis-instances.adoc b/doc-Configuring_High_Availability/cfme/common/smartstate-analysis-instances.adoc deleted file mode 100644 index 3a5d093ee..000000000 --- a/doc-Configuring_High_Availability/cfme/common/smartstate-analysis-instances.adoc +++ /dev/null @@ -1,14 +0,0 @@ -To manually initiate SmartState analysis on an instance: - -. Navigate to menu:Compute[Clouds > Instances]. -. Click on an instance in the *All Instances by Provider* nsection. -. Click image:1847.png[] (*Configuration*), and then image:1942.png[] (*Perform SmartState Analysis*). A pop-up window will appear to confirm the action. -. Click *OK*. The SmartState analysis will be initiated for the selected instance. - -To manually initiate SmartState analysis on an Infrastructure host: - -. Navigate to menu:Compute[Infrastructure > Providers]. -. Select a node in the *Nodes* section. -. Click image:1847.png[] (*Configuration*), and then image:1942.png[] (*Perform SmartState Analysis*). A pop-up window will appear to confirm the action. -. Click *OK*. The SmartState analysis will be initiated for the selected node. - diff --git a/doc-Configuring_High_Availability/cfme/common/smartstate.adoc b/doc-Configuring_High_Availability/cfme/common/smartstate.adoc deleted file mode 100644 index d502b8caa..000000000 --- a/doc-Configuring_High_Availability/cfme/common/smartstate.adoc +++ /dev/null @@ -1,12 +0,0 @@ - -// might need https://access.redhat.com/documentation/en-US/Red_Hat_CloudForms/2.0/html/Management_Engine_5.1_Settings_and_Operations_Guide/sect-SmartProxy_Affinity.html - -After enabling the required server roles, enable SmartState analysis. See https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/support-matrix/#smart_state_analysis_support[Smart State Analysis Support] (from https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/support-matrix/[Support Matrix]) and https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/managing-providers/#running_a_smartstate_analysis[Running a SmartState Analysis] (from https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/managing-providers/#running_a_smartstate_analysis[Managing Providers]) for more information. - -Enabling SmartState analysis is similar to xref:cf-caputils[], in that the procedure also involves enabling server roles on a specific server. To do so: - -. Navigate to menu:Settings[Configuration], and select the server to configure from menu:Settings[Zone] in the left pane of the appliance. -. Navigate to the *Server Roles* list in the menu:Server[Server Control] section. From there, set the appropriate SmartState roles to *ON*. Namely: -.. *SmartProxy* -.. *SmartState Analysis* -. Click *Save*. diff --git a/doc-Configuring_High_Availability/cfme/common/tenant-mapping.adoc b/doc-Configuring_High_Availability/cfme/common/tenant-mapping.adoc deleted file mode 100644 index 338bcdbd3..000000000 --- a/doc-Configuring_High_Availability/cfme/common/tenant-mapping.adoc +++ /dev/null @@ -1,3 +0,0 @@ -When adding an OpenStack cloud or infrastructure provider, you can enable _tenant mapping_ in {product-title} to map any existing tenants from that provider. This means {product-title} will create new cloud tenants to match each of existing OpenStack tenants; each new cloud tenant and its corresponding OpenStack tenant will have identical user memberships, quotas, access/security rules, and resources assignments. - -During a provider refresh, {product-title} will also check for any changes to the tenant list in OpenStack. {product-title} will create new cloud tenants to match any new tenants, and delete any cloud tenants whose corresponding OpenStack tenants no longer exist. {product-title} will also replicate any changes to OpenStack tenants to their corresponding cloud tenants. diff --git a/doc-Configuring_High_Availability/cfme/topics b/doc-Configuring_High_Availability/cfme/topics new file mode 120000 index 000000000..cd717d996 --- /dev/null +++ b/doc-Configuring_High_Availability/cfme/topics @@ -0,0 +1 @@ +../topics/ \ No newline at end of file diff --git a/doc-Configuring_High_Availability/common/Registering_Updating_Cloudforms.adoc b/doc-Configuring_High_Availability/common/Registering_Updating_Cloudforms.adoc deleted file mode 100644 index 01aa665bc..000000000 --- a/doc-Configuring_High_Availability/common/Registering_Updating_Cloudforms.adoc +++ /dev/null @@ -1,161 +0,0 @@ -[[Registering_Updating_Cloudforms]] -= Registering and Updating Red Hat CloudForms - -You can register appliances, edit customer information, and update appliances from the *Red Hat Updates* tab, accessible from menu:Settings[Configuration > Region] in the user interface. You can register your appliance to either Red Hat Content Delivery Network (CDN) or to a Red Hat Satellite server, which assign the necessary update packages to the CloudForms server. The subscription management service you register with will provide your systems with updates and allow additional management. - -The following tools are used during the update process: - -* `Yum` provides package installation, updates, and dependency checking. -* `Red Hat Subscription Manager` manages subscriptions and entitlements. -* `Red Hat Satellite Server` provides local system registration and updates from inside the customer’s firewall. - -[IMPORTANT] -====== -The update worker synchronizes the VMDB with the status of available CloudForms content every 12 hours. -====== - -[NOTE] -====== -Servers with the `RHN Mirror` role also act as a repository for other appliances to pull CloudForms package updates. -====== - -== Registering Appliances - -Before you can access and apply package updates, you must register and subscribe the CloudForms appliance to either Red Hat Content Delivery Network (CDN) or to a Red Hat Satellite server. - -You need the following to register your appliance: - -* Your Red Hat account login or Red Hat Network Satellite login -* A Red Hat subscription that covers your product - -image::common/cfme-register-appliance.png[] - -To register your appliance with Red Hat Subscription Management or Red Hat Satellite 6, first configure the region with your registration details. These settings will apply to all appliances in this region. - -To configure registration for a region: - -. Log in to the appliance as the `admin` user. -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Edit Registration*. -. Configure registration details for the CloudForms appliance using one of two available options: -.. To register with Red Hat Subscription Management: -... In *Register to*, select *Red Hat Subscription Management*. -... Enter the *Red Hat Subscription Management Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.5-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the Red Hat CloudForms repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat account information and click *Validate*. -... After your credentials are validated, click *Save*. -.. To register with Red Hat Satellite 6: -... In *Register to*, select *Red Hat Satellite 6*. -... Enter the *Red Hat Satellite 6 Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.5-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the Red Hat CloudForms repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat Satellite account information and click *Validate*. -... After your credentials are validated, click *Save*. - -Your appliance now appears in the *Appliance Updates* list as `Not registered`. - -To register your appliance: - -. Select the appliance from the *Appliance Updates* list. -. Click *Register* to subscribe the appliance and attach subscriptions. - -Registering and attaching subscriptions takes a few minutes. The subscription process is complete when the appliance reports that it is `Subscribed` under *Update Status*, and `Registered` under *Last Message*. - -image::common/appliance_subscribed.png[] - -You can now apply updates to your appliance. - -[[Updating_Appliances]] -== Updating Appliances - -An important part of securing Red Hat CloudForms is to ensure your appliances use the latest packages. -Package updates to the appliance contain patches for any software bugs, including possible security bugs. - -The *Red Hat Updates* tab enables you to check for updates and update registered appliances. Any services requiring a restart to apply updates are automatically restarted as part of the *Red Hat Updates* process. - -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Check For Updates* to search the Content Delivery Network (CDN) for any updated CloudForms packages. If an appliance update is available, it will be listed with the available version. -. Click *Apply CFME Update* to install and update CloudForms packages. The CloudForms service will be automatically restarted as needed. - - -[IMPORTANT] -====== -Red Hat recommends updating the appliance using the *Red Hat Updates* tab only, which automatically restarts services and the appliance if needed. Running updates from the command line requires manually restarting the CloudForms service and sometimes the appliance. If updating the CloudForms appliance from the command line, use the `yum -y update cfme-appliance` command to update only CloudForms and its dependencies, and to avoid any potential incompatibilities that could be introduced by running `yum update`. -====== - - -The following options are available in the *Appliance Updates* section of *Red Hat Updates*: - -.Options Available in Appliance Updates -[cols="1,1", frame="all", options="header"] -|=== -| - - Option - - -| - - Use - -| - Refresh List - - -| - Refreshes the list of appliances. - - -| - Check for Updates - - -| - Checks for all available CloudForms updates using `yum`. - -| - Register - - -| - Attempts to register the appliance if it is not already registered. CloudForms subscribes to the `rhel-x86_64-server-6-cf-me-3` RHN channel for RHN-registered appliances, and to the products designated by Red Hat product certification for subscription-manager registered appliances. The Red Hat Enterprise Linux channels are enabled by default on registration. In addition, CloudForms automatically checks for updates after registering. -| - Apply CFME Update - - -| - Applies updates to CloudForms packages only. Specifically, this option runs the `yum -y update cfme-appliance` command. This command installs every package listed in the dependency tree if it is not already installed. If a specific version of a package is required, that version of the package is installed or upgraded. No other packages, such as PostgreSQL or Red Hat Enterprise Linux, are updated. The appliance may be rebooted automatically during this process. - - -|=== - - -[NOTE] -====== -If the appliance is registered to Red Hat Satellite, you can use content views to manage updates for CloudForms. For more information, see https://access.redhat.com/documentation/en/red-hat-satellite/6.2/content-management-guide/chapter-7-creating-content-views[Creating Content Views] in the _Red Hat Satellite 6 Content Management Guide_. -====== - - -== Updating the Appliance Operating System - -Updating the appliance’s operating system requires a manual update using the `yum` command. This command updates the CloudForms packages, plus all RPMs on the appliance, and is supported only when used as part of migration. - -[IMPORTANT] -====== -Scheduled downtime is required while updating system packages for the following reasons: - -* Some updates may interrupt CloudForms operations. -* Updates for the PostgreSQL database server suspend CloudForms operations. -* System updates may require a reboot of the CloudForms appliance. - -Red Hat recommends updating the appliance using the *Red Hat Updates* tab in the CloudForms user interface, which automatically restarts services and the appliance if needed. See xref:Updating_Appliances[] for instructions. -====== - -To update the appliance operating system: - -. Log in to the appliance console as the root user. -. Run the `yum update` command and confirm any updates. -. Restart the appliance as required. diff --git a/doc-Configuring_High_Availability/common/attributes/cfme.adoc b/doc-Configuring_High_Availability/common/attributes/cfme.adoc deleted file mode 100644 index c2b13b632..000000000 --- a/doc-Configuring_High_Availability/common/attributes/cfme.adoc +++ /dev/null @@ -1,7 +0,0 @@ - -:product-title: Red Hat CloudForms -:product-title_short: CloudForms -:product-title_short_l: cloudforms -:product-title_abbr: cfme -:product-title_abbr_uc: CFME - diff --git a/doc-Configuring_High_Availability/common/attributes/miq.adoc b/doc-Configuring_High_Availability/common/attributes/miq.adoc deleted file mode 100644 index 95d9a6c77..000000000 --- a/doc-Configuring_High_Availability/common/attributes/miq.adoc +++ /dev/null @@ -1,7 +0,0 @@ - -:product-title: ManageIQ -:product-title_short: ManageIQ -:product-title_short_l: manageiq -:product-title_abbr: miq -:product-title_abbr_uc: MIQ - diff --git a/doc-Configuring_High_Availability/common/cap-util-assign-server-roles.adoc b/doc-Configuring_High_Availability/common/cap-util-assign-server-roles.adoc deleted file mode 100644 index b2866f0d1..000000000 --- a/doc-Configuring_High_Availability/common/cap-util-assign-server-roles.adoc +++ /dev/null @@ -1,14 +0,0 @@ -. Navigate to menu:Settings[Configuration], and select the server to configure from menu:Settings[Zone] in the left pane of the appliance. -. Navigate to the *Server Roles* list in the menu:Server[Server Control] section. From there, set the appropriate Capacity and Utilization roles to *ON*. Namely: -.. *Capacity & Utilization Coordinator* -.. *Capacity & Utilization Data Collector* -.. *Capacity & Utilization Data Processor* -. Click *Save*. - -Data collection is enabled immediately. However, the first collection begins -5 minutes after the server is started, and every 10 minutes after that. -Therefore, the longest the collection takes after enabling the Capacity & -Utilization collector server role is 10 minutes. The first collection -from a particular provider may take a few minutes since {product-title} -is gathering data points going one month back in time. - diff --git a/doc-Configuring_High_Availability/common/cap-util-note-metrics-collection.adoc b/doc-Configuring_High_Availability/common/cap-util-note-metrics-collection.adoc deleted file mode 100644 index 9144c1512..000000000 --- a/doc-Configuring_High_Availability/common/cap-util-note-metrics-collection.adoc +++ /dev/null @@ -1,2 +0,0 @@ -For metrics collection to work properly, you also need to configure {product-title} to allow for all three *Capacity & Utilization* server roles, which are available under menu:Configure[Configuration > Server > Server Control]. -ifdef::cfme[For more information on capacity and utilization collection, see https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/deployment-planning-guide/#assigning_the_capacity_and_utilization_server_roles[Assigning the Capacity and Utilization Server Roles] in the _Deployment Planning Guide_.] diff --git a/doc-Configuring_High_Availability/common/catalog-item-creation.adoc b/doc-Configuring_High_Availability/common/catalog-item-creation.adoc deleted file mode 100644 index 9199ad20d..000000000 --- a/doc-Configuring_High_Availability/common/catalog-item-creation.adoc +++ /dev/null @@ -1,25 +0,0 @@ -. Navigate to menu:Services[Catalogs]. -. Click the *Catalog Items* accordion. -. Click image:1847.png[](*Configuration*), and then image:1862.png[](*Add a New Catalog Item*). -. Select the *Catalog Item Type* you are adding. The dialogs that appear will be filtered based on the selected type of provider. For example, you will only see templates residing on Red Hat Providers, if the *Catalog Item Type* is *Redhat*. -image:2357.png[] -. In the *Basic Info* subtab: -.. Type a *Name/Description*. -.. Check *Display in Catalog* to edit *Catalog*, *Dialog*, and *Entry Point(NS/Cls/Inst)* options. -... *Provisioning Entry Point (Domain/NS/Cls/Inst)* requires you to select an Automate instance to run upon provisioning. -... *Retirement Entry Point (Domain/NS/Cls/Inst)* requires you to select an Automate instance to run upon retirement. -image:Catalogitem-statemachine.png[] -+ -[NOTE] -======== -The entry point must be a State Machine since the *Provisioning Entry Point* list is filtered to only show State Machine class instances. No other entry points will be available from the *Provisioning Entry Point* field. -======== -+ -[NOTE] -======== -You can only choose from the catalogs and dialogs you have already created. If you haven't done so, leave the values blank and edit later. -======== -+ -. In the *Details* subtab, write a *Long Description* for the catalog item. -. In the *Request Info* subtab, select provisioning options that apply to the provider chosen. For more information, refer to the sections on Provisioning Virtual Machines and Provisioning Instances. -. Click *Add*. diff --git a/doc-Configuring_High_Availability/common/catalog-order.adoc b/doc-Configuring_High_Availability/common/catalog-order.adoc deleted file mode 100644 index 81ce43e82..000000000 --- a/doc-Configuring_High_Availability/common/catalog-order.adoc +++ /dev/null @@ -1,10 +0,0 @@ -. Navigate to menu:Services[Catalogs]. -. Click the *Service Catalogs* accordion, and select the service to provision. -. Click *Order*. - -/////////////////////////////// -. Navigate to menu:Services[Catalogs]. -. Click the *Service Catalogs* accordion, and select the service to provision. -. Click *Order*. The dialog appears. -. Select the options in the *Service* dialog. -/////////////////////////////// diff --git a/doc-Configuring_High_Availability/common/cfme-install-appliance-as-vm.adoc b/doc-Configuring_High_Availability/common/cfme-install-appliance-as-vm.adoc deleted file mode 100644 index 13d9f171b..000000000 --- a/doc-Configuring_High_Availability/common/cfme-install-appliance-as-vm.adoc +++ /dev/null @@ -1,23 +0,0 @@ -// Using virt-manager command, we will install the CF appliance. Ensure the cfme.qcow2 file is placed in /var/lib/libvirt/images/ directory and make sure the security context of the file is correct. Use 4 vcpus and 8192 MiB of RAM for the appliance. Add a second network interface of virto type. - -. Log in as `root` to the virtual machine host. -. Copy the appliance to `/var/lib/libvirt/images/`. -. Run `virt-manager`. Doing so will launch the Virtual Machine Manager. -. Enter a name for the virtual machine in the *Name* field; for example, use `my-cfme`. Select *Import existing disk image* and click *Forward*. -+ -image:virt-manager-install-step1.png[] -. Click *Browse* to select the copy of the appliance stored in `/var/lib/libvirt/images/`. -+ -image:virt-manager-install-step2.png[] -+ -Select *Linux* from the *OS type* drop-down. For *Version*, select *Red Hat Enterprise Linux 7 or later*. Click *Forward*. -. Configure the appliance with 4 CPUs and 8192MiB or memory. Select *Customize configuration before install* then click *Finish*. -+ -image:virt-manager-install-step3.png[] -. Add a second network interface for the virtual machine. Select *virtio* as its *Device Model*. -+ -image:virt-manager-install-step4.png[] -. Configure the virtual machine with two additional virtual disks. One will be used for the internal database (xref:configuring_a_database[]), while the other will be used for mounting images and SmartState analysis. -+ -image:virt-manager-install-step5.png[] -. Click *Finish* to launch the virtual machine. diff --git a/doc-Configuring_High_Availability/common/cfme-obtaining-the-appliance.adoc b/doc-Configuring_High_Availability/common/cfme-obtaining-the-appliance.adoc deleted file mode 100644 index 9d83ebec4..000000000 --- a/doc-Configuring_High_Availability/common/cfme-obtaining-the-appliance.adoc +++ /dev/null @@ -1,5 +0,0 @@ -. Go to link:https://access.redhat.com[access.redhat.com] and log in to the Red Hat Customer Portal using your customer account details. -. Click *Downloads* in the menu bar. -. Click *A-Z* to sort the product downloads alphabetically. -. Click *Red Hat CloudForms* to access the product download page. The latest version of each download displays by default. -. From the list of installers and images under *Product Software*, choose *OpenStack Virtual Appliance* option with the latest version and click *Download Now*. diff --git a/doc-Configuring_High_Availability/common/chargeback-report-creation.adoc b/doc-Configuring_High_Availability/common/chargeback-report-creation.adoc deleted file mode 100644 index 62c7c511e..000000000 --- a/doc-Configuring_High_Availability/common/chargeback-report-creation.adoc +++ /dev/null @@ -1,29 +0,0 @@ -. Navigate to menu:Cloud Intel[Reports]. -. Click the *Reports* accordion. -. Click image:1847.png[]*(Configuration)*, image:1862.png[] *(Add a new Report)*. -. On the *Columns* tab, fill out the *Basic Report Info* area. -+ -* Type a unique name in *Menu Name* for how you want the report described in the menu list. -* Type the *Title* to display on the report. - -. Add fields in the *Configure Report Columns* area. -+ -* From the *Base the report on* list, select *Chargebacks*. -* Select the fields to include in the report from the *Available Fields* list, then click image:2289.png[] *(Move selected fields down)*. - In addition to the fields, you can also select any tags that you have created and assigned. -* Change the order of the fields in the report by clicking image:2290.png[] *(Move selected fields up)* or image:2289.png[] *(Move selected fields down)]*. - -. Click the *Formatting* tab to set the size of paper for a PDF and column header format. -+ -* From the *PDF Output* area, select the page size from the *Page Size* list. -* From *Specify Column Headers and Formats*, type the text to display for each field. - For each numeric field, you can also set the numeric format. - -. Click the *Filter* tab to set filters for the data displayed in the report. -+ -* From *Chargeback Filters*, select how you want the costs to show, the tag category, the tag, and how you want the items grouped. -* From *Chargeback Interval*, select the time interval. - You must have a full interval worth of data in order to select an option other than *Partial* in the *Daily Ending With* list. - -. Click the *Preview* tab, and then *Load* to see what the report will look like. -. When you are satisfied that you have the report that you want, click *Add* to create the new report. diff --git a/doc-Configuring_High_Availability/common/configuration-advanced.adoc b/doc-Configuring_High_Availability/common/configuration-advanced.adoc deleted file mode 100644 index c7cd348af..000000000 --- a/doc-Configuring_High_Availability/common/configuration-advanced.adoc +++ /dev/null @@ -1,30 +0,0 @@ -After logging in, you can use the following menu items for advanced configuration of the appliance: - -* Use *Set DHCP Network Configuration* to use DHCP to obtain the IP address and network configuration for your {product-title} appliance. The appliance is initially configured as a DHCP client with bridged networking. -* Use *Set Static Network Configuration* if you have a specific IP address and network settings you need to use for the {product-title} appliance. -* Use *Test Network Configuration* to check that name resolution is working correctly. -* Use *Set Hostname* to specify a hostname for the {product-title} appliance. -+ -[IMPORTANT] -==== -A valid fully qualified hostname for the {product-title} appliance is required for SmartState analysis to work correctly, -==== -+ -* Use *Set Timezone* to configure the time zone for the {product-title} appliance. -* Use *Set Date and Time* to configure the date and time for the {product-title} appliance. -* Use *Restore Database from Backup* to restore the Virtual Management Database (VMDB) from a previous backup. -* Use *Setup Database Region* to create regions for VMDB replication. -* Use *Configure Database* to configure the VMDB. Use this option to configure the database for the appliance after installing and running it for the first time. -* Use *Configure Database Replication* to configure a primary or standby server for VMDB replication. -* Use *Configure Database Maintenance* to configure the VMDB maintenance schedule. -* Use *Configure Application Database Failover Monitor* to start or stop VMDB failover monitoring. -* Use *Extend Temporary Storage* to add temporary storage to the appliance. The appliance formats an unpartitioned disk attached to the appliance host and mounts it at `/var/www/miq_tmp`. The appliance uses this temporary storage directory to perform certain image download functions. -* Use *Configure External Authentication (httpd)* to configure authentication through an IPA server. -* Use *Generate Custom Encryption Key* to regenerate the encryption key used to encode plain text password. -* Use *Harden Appliance Using SCAP Configuration* to apply Security Content Automation Protocol (SCAP) standards to the appliance. You can view these SCAP rules in the `/var/www/miq/lib/appliance_console/config/scap_rules.yml` file. -* Use *Stop EVM Server Processes* to stop all server processes. You may need to do this to perform maintenance. -* Use *Start EVM Server Processes* to start the server. You may need to do this after performing maintenance. -* Use *Restart Appliance* to restart the {product-title} appliance. You can either restart the appliance and clear the logs or just restart the appliance. -* Use *Shut Down Appliance* to power down the appliance and exit all processes. -* Use *Summary Information* to go back to the network summary screen for the {product-title} appliance. -* Use *Quit* to leave the {product-title} appliance console. diff --git a/doc-Configuring_High_Availability/common/configuration-db.adoc b/doc-Configuring_High_Availability/common/configuration-db.adoc deleted file mode 100644 index 2d299b437..000000000 --- a/doc-Configuring_High_Availability/common/configuration-db.adoc +++ /dev/null @@ -1,43 +0,0 @@ -[IMPORTANT] -==== -Before installing an internal database, add a disk to the infrastructure hosting your appliance. See the documentation specific to your infrastructure for instructions for adding a disk. As a storage disk usually cannot be added while a virtual machine is running, Red Hat recommends adding the disk before starting the appliance. {product-title} only supports installing of an internal VMDB on blank disks; installation will fail if the disks are not blank. -==== - -. Start the appliance and open a terminal from your virtualization or cloud provider. -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press *Enter* to manually configure settings. -. Select *8) Configure Database* from the menu. -. You are prompted to create or fetch an encryption key. -* If this is the first {product-title} appliance, choose *1) Create key*. -* If this is not the first {product-title} appliance, choose *2) Fetch key* from remote machine to fetch the key from the first {product-title} appliance. All {product-title} appliances in a multi-region deployment must use the same key. -. Choose *1) Internal* for the database location. -. Choose a disk for the database. This can be either a disk you attached previously, or a partition on the current disk. -+ -[IMPORTANT] -==== -Red Hat recommends using a separate disk for the database. -==== -+ -If there is an unpartitioned disk attached to the virtual machine, the dialog will show options similar to the following: -+ ----- -1) /dev/vdb: 20480 -2) Don't partition the disk ----- -+ -* Enter *1* to choose `/dev/vdb` for the database location. This option creates a logical volume using this device and mounts the volume to the appliance in a location appropriate for storing the database. The default location is `/var/opt/rh/rh-postgresql95/lib/pgsql`, which can be found in the environment variable `$APPLIANCE_PG_MOUNT_POINT`. -* Enter *2* to continue without partitioning the disk. A second prompt will confirm this choice. Selecting this option results in using the root filesystem for the data directory (not advised in most cases). -. Enter *Y* or *N* for *Configure this server as a dedicated database instance?* -* Select *Y* to configure the appliance _only_ as a database. As a result, the appliance is configured as a basic PostgreSQL server, without a user interface. -* Select *N* to configure the appliance with the full administrative user interface. -. When prompted, enter a unique number to create a new region. -+ -[IMPORTANT] -==== -Creating a new region destroys any existing data on the chosen database. -==== -+ -. Create and confirm a password for the database. - -{product-title} then configures the internal database. \ No newline at end of file diff --git a/doc-Configuring_High_Availability/common/configuration-gui.adoc b/doc-Configuring_High_Availability/common/configuration-gui.adoc deleted file mode 100644 index 4f86b7dbe..000000000 --- a/doc-Configuring_High_Availability/common/configuration-gui.adoc +++ /dev/null @@ -1,19 +0,0 @@ -The options under the *Configuration* menu allow you to configure global options for your {product-title} environment, view diagnostic information, and view analytics on the servers in the environment. The menu displays the {product-title} environment at the enterprise, zone, and server levels. - -There are four main areas: - -* *Settings* -+ -This menu allows you to configure global settings for your {product-title} infrastructure. You can also create analysis profiles and schedules for these profiles. -+ -* *Access Control* -+ -This menu contains options for configuring users, groups, roles, and tenants. -+ -* *Diagnostics* -+ -This menu displays the status of your servers and their roles and provides access to logs. -+ -* *Database* -+ -specify the location of your Virtual Machine Database (VMDB) and its login credentials. diff --git a/doc-Configuring_High_Availability/common/configuration-register-appliance.adoc b/doc-Configuring_High_Availability/common/configuration-register-appliance.adoc deleted file mode 100644 index 9929d15aa..000000000 --- a/doc-Configuring_High_Availability/common/configuration-register-appliance.adoc +++ /dev/null @@ -1,41 +0,0 @@ -Before you can access and apply package updates, you must register and subscribe the {product-title} appliance to either Red Hat Content Delivery Network (CDN) or to a Red Hat Satellite server. - -You need the following to register your appliance: - -* Your Red Hat account login or Red Hat Network Satellite login -* A Red Hat subscription that covers your product - -To register your appliance with Red Hat Subscription Management or Red Hat Satellite 6, first configure the region with your registration details. These settings will apply to all appliances in this region. - -To configure registration for a region: - -. Log in to the appliance as the `admin` user. -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Edit Registration*. -. Configure registration details for the {product-title} appliance using one of two available options: -.. To register with Red Hat Subscription Management: -... In *Register to*, select *Red Hat Subscription Management*. -... Enter the *Red Hat Subscription Management Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.7-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the {product-title} repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat account information and click *Validate*. -... After your credentials are validated, click *Save*. -.. To register with Red Hat Satellite 6: -... In *Register to*, select *Red Hat Satellite 6*. -... Enter the *Red Hat Satellite 6 Address*. The default is `subscription.rhn.redhat.com`. -... Enter the *Repository Name(s)*. The default is `cf-me-5.7-for-rhel-7-rpms rhel-server-rhscl-7-rpms`, which are the Red Hat CloudForms repository and the Red Hat Software Collections repository. -... To use a HTTP proxy, select *Use HTTP Proxy* and enter your proxy details. -... Enter your Red Hat Satellite account information and click *Validate*. -... After your credentials are validated, click *Save*. - -Your appliance now appears in the *Appliance Updates* list as `Not registered`. - -To register your appliance: - -. Select the appliance from the *Appliance Updates* list. -. Click *Register* to subscribe the appliance and attach subscriptions. - -Registering and attaching subscriptions takes a few minutes. The subscription process is complete when the appliance reports that it is `Subscribed` under *Update Status*, and `Registered` under *Last Message*. - -You can now apply updates to your appliance. diff --git a/doc-Configuring_High_Availability/common/configuration-update-appliance.adoc b/doc-Configuring_High_Availability/common/configuration-update-appliance.adoc deleted file mode 100644 index deb3a6f28..000000000 --- a/doc-Configuring_High_Availability/common/configuration-update-appliance.adoc +++ /dev/null @@ -1,10 +0,0 @@ -An important part of securing {product-title} is to ensure your appliances use the latest packages. -Package updates to the appliance contain patches for any software bugs, including possible security bugs. - -The *Red Hat Updates* tab enables you to check for updates and update registered appliances. Any services requiring a restart to apply updates are automatically restarted as part of the *Red Hat Updates* process. - -. Navigate to menu:Settings[Configuration]. -. Select *Region* in the accordion menu and click the *Red Hat Updates* tab. -. Click *Check For Updates* to search the Content Delivery Network (CDN) for any updated CloudForms packages. If an appliance update is available, it will be listed with the available version. -. Click *Apply CFME Update* to install and update {product-title} packages. The {product-title} service will be automatically restarted as needed. - diff --git a/doc-Configuring_High_Availability/common/configuration.adoc b/doc-Configuring_High_Availability/common/configuration.adoc deleted file mode 100644 index 67fc492b6..000000000 --- a/doc-Configuring_High_Availability/common/configuration.adoc +++ /dev/null @@ -1,94 +0,0 @@ -[[Configuring-cloudforms]] -== Configuring {product-title} - -Although the {product-title} appliance comes configured to be integrated immediately into your environment, you can make some changes to its configuration. - -[NOTE] -==== -The {product-title} appliance is intended to have minimal configuration options. -==== - -[[changing-configuration-settings]] -=== Changing Configuration Settings - -The following procedure describes how to make changes to the configuration settings on the {product-title} appliance. - -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press `Enter` to manually configure settings. -. Press the number for the item you want to change, and press `Enter`. The options for your selection are displayed. -. Follow the prompts to make the changes. -. Press `Enter` to accept a setting where applicable. - -[NOTE] -==== -The {product-title} appliance console automatically logs out after five minutes of inactivity. -==== - -[[advanced-configuration-settings]] -=== Advanced Configuration Settings - -include::configuration-advanced.adoc[] - -[[configuring_a_database]] -=== Configuring a Database for {product-title} - -Before using {product-title}, configure the database options for it. {product-title} provides two options for database configuration: - -* Install an internal PostgreSQL database to the appliance -* Configure the appliance to use an external PostgreSQL database - -[[configuring-an-internal-database]] -=== Configuring an Internal Database - -include::configuration-db.adoc[] - -[[configuring-an-external-database]] -=== Configuring an External Database - -The `postgresql.conf` file used with {product-title} databases requires specific settings for correct operation. For example, it must correctly reclaim table space, control session timeouts, and format the PostgreSQL server log for improved system support. Due to these requirements, Red Hat recommends that external {product-title} databases use a `postgresql.conf` file based on the standard file used by the {product-title} appliance. - -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 -necessary to alter the `max_connections` setting. - -Because the `postgresql.conf` file controls the operation of all databases managed by a single instance of PostgreSQL, do not mix {product-title} databases with other types of databases in a single PostgreSQL instance. - -[NOTE] -==== -{product-title} 4.x requires PostgreSQL version 9.4. -==== - -. Start the appliance and open a terminal console from your virtualization or cloud provider. -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press *Enter* to manually configure settings. -. Select *8) Configure Database* from the menu. -. You are prompted to create or fetch a security key. -* If this is the first {product-title} appliance, select the option to create a key. -* If this is not the first {product-title} appliance, select the option to fetch the key from the first {product-title} appliance. All {product-title} appliances in a multi-region deployment must use the same key. -. Choose *2) External* for the database location. -. Enter the database hostname or IP address when prompted. -. Enter the database name or leave blank for the default (`vmdb_production`). -. Enter the database username or leave blank for the default (`root`). -. Enter the chosen database user's password. -. Confirm the configuration if prompted. - -{product-title} will then configure the external database. - -[[configuring-a-worker-appliance]] -=== Configuring a Worker Appliance - -You can configure a worker appliance through the terminal. These steps demonstrate how to join a worker appliance to an appliance that already has a region configured with a database. - -. Start the appliance and open a terminal from your virtualization or cloud provider. -. After starting the appliance, log in with a user name of `root` and the default password of `smartvm`. This displays the Bash prompt for the `root` user. -. Enter the `appliance_console` command. The {product-title} appliance summary screen displays. -. Press *Enter* to manually configure settings. -. Select *8) Configure Database* from the menu. -. You are prompted to create or fetch a security key. Select the option to fetch the key from the first {product-title} appliance. All {product-title} appliances in a multi-region deployment must use the same key. -. Choose *2) External* for the database location. -. Enter the database hostname or IP address when prompted. -. Enter the database name or leave blank for the default (`vmdb_production`). -. Enter the database username or leave blank for the default (`root`). -. Enter the chosen database user's password. -. Confirm the configuration if prompted. diff --git a/doc-Configuring_High_Availability/common/initial-login-changepw.adoc b/doc-Configuring_High_Availability/common/initial-login-changepw.adoc deleted file mode 100644 index 8203e559d..000000000 --- a/doc-Configuring_High_Availability/common/initial-login-changepw.adoc +++ /dev/null @@ -1,9 +0,0 @@ -Change your password to ensure more private and secure access to {product-title}. - -. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance) -. Click *Update Password* beneath the *Username* and *Password* text fields. -. Enter your current *Username* and *Password* in the text fields. -. Input a new password in the *New Password* field. -. Repeat your new password in the *Verify Password* field. -. Click *Login*. - diff --git a/doc-Configuring_High_Availability/common/initial-login.adoc b/doc-Configuring_High_Availability/common/initial-login.adoc deleted file mode 100644 index b1d76812a..000000000 --- a/doc-Configuring_High_Availability/common/initial-login.adoc +++ /dev/null @@ -1,8 +0,0 @@ - -Once {product-title} is installed, you can log in and perform administration tasks. - -Log in to {product-title} for the first time after installing by: - -. Navigate to the URL for the login screen. (https://xx.xx.xx.xx on the virtual machine instance) -. Enter the default credentials (Username: *admin* | Password: *smartvm*) for the initial login. -. Click *Login*. diff --git a/doc-Configuring_High_Availability/common/introduction.adoc b/doc-Configuring_High_Availability/common/introduction.adoc deleted file mode 100644 index a085c0552..000000000 --- a/doc-Configuring_High_Availability/common/introduction.adoc +++ /dev/null @@ -1,197 +0,0 @@ -[[introduction]] -== Introduction to {product-title} - -{product-title} delivers the insight, control, and automation that enterprises need to address the challenges of managing virtual environments. -This technology enables enterprises with existing virtual infrastructures to improve visibility and control, and those starting virtualization deployments to build and operate a well-managed virtual infrastructure. - -{product-title} provides the following feature sets: - -* Insight: Discovery, Monitoring, Utilization, Performance, Reporting, Analytic, Chargeback, and Trending. -* Control: Security, Compliance, Alerting, and Policy-Based Resource, and Configuration Enforcement. -* Automate: IT Process, Task and Event, Provisioning, and Workload Management and Orchestration. -* Integrate: Systems Management, Tools and Processes, Event Consoles, Configuration Management Database (CMDB), Role-based Administration (RBA), and Web Services. - -[[architecture]] -=== Architecture - -The diagram below describes the capabilities of {product-title}. Its features are designed to work together to provide robust management and maintenance of your virtual infrastructure. -image:1845.png[] - -The architecture comprises the following components: - -* The {product-title} appliance (appliance) which is supplied as a secure, high-performance, preconfigured virtual machine. It provides support for HTTPS communications. -* The {product-title} Server (Server) resides on the appliance. It is the software layer that communicates between the SmartProxy and the Virtual Management Database. -It includes support for HTTPS communications. -* The Virtual Management Database (VMDB) resides either on the appliance or another computer accessible to the appliance. -It is the definitive source of intelligence collected about your Virtual Infrastructure. It also holds status information regarding appliance tasks. -* The {product-title} Console (Console) is the Web interface used to view and control the Server and appliance. -It is consumed through Web 2.0 mash-ups and web services (WS Management) interfaces. -* The SmartProxy can reside on the appliance or on an ESX Server. If not embedded in the Server, the SmartProxy can be deployed from the appliance. -A SmartProxy agent must configured in each storage location, and must be visible to the appliance. The SmartProxy acts on behalf of the appliance communicating with it over HTTPS on standard port 443. - -[[requirements]] -=== Requirements - -To use {product-title}, certain virtual hardware, database, and browser requirements must be met in your environment. - - -[[virtual-hardware-requirements]] -==== Virtual Hardware Requirements - -The {product-title} appliance requires the following virtual hardware at minimum: - -* 4 VCPUs -* 8 GB RAM -* 44 GB HDD + optional database disk - -[[database-requirements]] -==== Database Requirements - -Red Hat recommends allocating the virtual machine disk fully at the time of creation. Three main factors affect the size of your database over time: - -* Virtual Machine Count: the most important factor in the calculation of virtual machine database (VMDB) size over time. -* Host Count: the number of hosts associated with the provider. -* Storage Count: the number of individual storage elements as seen from the perspective of the provider or host. It is not the total number of virtual disks for all virtual machines. - -Use the following table as a guideline to calculate minimum requirements for your database: - -image:5780.png[] - - -[[browser-requirements]] -==== Browser Requirements - -To use {product-title}, the following browser requirements must be met: - -* One of the following web browsers: -** Mozilla Firefox for versions supported under Mozilla's Extended Support Release (ESR) -** Internet Explorer 10 or higher -** Google Chrome for Business -* A monitor with minimum resolution of 1280x1024. -* Adobe Flash Player 9 or above. At the time of publication, you can access it at http://www.adobe.com/products/flashplayer/ - - -[IMPORTANT] -==== -Due to browser limitations, Red Hat supports logging in to only one tab for each multi-tabbed browser. Console settings are saved for the active tab only. For the same reason, {product-title} does not guarantee that the browser's *Back* button will produce the desired results. Red Hat recommends using the breadcrumbs provided in the Console. -==== - -[[additional-requirements]] -==== Additional Requirements - -Additionally, the following must be configured to use {product-title}: - -* The {product-title} appliance must already be installed and activated in your enterprise environment. -* The SmartProxy must have visibility to the virtual machines and cloud instances that you want to control. -* The resources that you want to control must have a SmartProxy associated with them. - - -[[terminology]] -=== Terminology - -The following terms are used throughout this document. Review them before proceeding. - -Account Role:: The level of access a user has to different parts and functions of the {product-title} console. There are a variety of Account Roles, which can be assigned to users to restrict or allow access to parts of the console and virtual infrastructure. - -Action:: An execution that is performed after a condition is evaluated. - -Alert:: {product-title} alerts notify administrators and monitoring systems of critical configuration changes and threshold limits in the virtual environment. -The notification can take the form of either an email or an SNMP trap. - -Analysis Profile:: A customized scan of hosts, virtual machines, or instances. You can collect information from categories, files, event logs, and registry entries. - -Cloud:: A pool of on-demand and highly available computing resources. The usage of these resources are scaled depending on the user requirements and metered for cost. - -{product-title} Appliance:: A virtual machine where the virtual management database (VMDB) and {product-title} reside. - -{product-title} Console:: A web-based interface into the {product-title} appliance. - -{product-title} Role:: A designation assigned to a {product-title} server that defines what a {product-title} server can do. - -{product-title} Server:: The application that runs on the {product-title} appliance and communicates with the SmartProxy and the VMDB. - -Cluster:: Hosts that are grouped together to provide high availability and load balancing. - -Condition:: A control policy test triggered by an event, which determines a subsequent action. - -Discovery:: Process run by the {product-title} server which finds virtual machine and cloud providers. - -Drift:: The comparison of a virtual machine, instance, host, cluster to itself at different points in time. - -Event:: A trigger to check a condition. - -Event Monitor:: Software on the {product-title} appliance which monitors external providers for events and sends them to the {product-title} server. - -Host:: A computer running a hypervisor, capable of hosting and monitoring virtual machines. Supported hypervisors include RHEV-H, VMware ESX hosts, Windows Hyper-V hosts. - -Instance/Cloud Instance:: A on-demand virtual machine based upon a predefined image and uses a scalable set of hardware resources such as CPU, memory, networking interfaces. - -Managed/Registered VM:: A virtual machine that is connected to a host and exists in the VMDB. Also, a template that is connected to a provider and exists in the VMDB. -Note that templates cannot be connected to a host. - -Managed/Unregistered VM:: A virtual machine or template that resides on a repository or is no longer connected to a provider or host and exists in the VMDB. -A virtual machine that was previously considered registered may become unregistered if the virtual machine was removed from provider inventory. - -Provider:: A computer on which software is loaded which manages multiple virtual machines that reside on multiple hosts. - -Policy:: A combination of an event, a condition, and an action used to manage a virtual machine. - -Policy Profile:: A set of policies. - -Refresh:: A process run by the {product-title} server which checks for relationships of the provider or host to other resources, such as storage locations, repositories, virtual machines, or instances. -It also checks the power states of those resources. - -Regions:: Regions are used to create a central database for reporting and charting. Regions are used primarily to consolidate multiple VMDBs into one master VMDB for reporting. - -Resource:: A host, provider, instance, virtual machine, repository, or datastore. - -Resource Pool:: A group of virtual machines across which CPU and memory resources are allocated. - -Repository:: A place on a datastore resource which contains virtual machines. - -SmartProxy:: The SmartProxy is a software agent that acts on behalf of the {product-title} appliance to perform actions on hosts, providers, storage and virtual machines. - -:: The SmartProxy can be configured to reside on the {product-title} appliance or on an ESX server version. -The SmartProxy can be deployed from the {product-title} appliance, and provides visibility to the VMFS storage. Each storage location must have a SmartProxy with visibility to it. -The SmartProxy acts on behalf of the {product-title} appliance. If the SmartProxy is not embedded in the {product-title} server, it communicates with the {product-title} appliance over HTTPS on standard port 443. - -SmartState Analysis:: Process run by the SmartProxy which collects the details of a virtual machine or instance. Such details include accounts, drivers, network information, hardware, and security patches. This process is also run by the {product-title} server on hosts and clusters. The data is stored in the VMDB. - -SmartTags:: Descriptors that allow you to create a customized, searchable index for the resources in your clouds and infrastructure. - -Storage Location:: A device, such as a VMware datastore, where digital information resides that is connected to a resource. - -Tags:: Descriptive terms defined by a {product-title} user or the system used to categorize a resource. - -Template:: A template is a copy of a preconfigured virtual machine, designed to capture installed software and software configurations, as well as the hardware configuration, of the original virtual machine. - -Unmanaged Virtual Machine:: Files discovered on a datastore that do not have a virtual machine associated with them in the VMDB. -These files may be registered to a provider that the {product-title} server does not have configuration information on. -Possible causes may be that the provider has not been discovered or that the provider has been discovered, but no security credentials have been provided. - -Virtual Machine:: A software implementation of a system that functions similar to a physical machine. -Virtual machines utilize the hardware infrastructure of a physical host, or a set of physical hosts, to provide a scalable and on-demand method of system provisioning. - -Virtual Management Database (VMDB):: Database used by the {product-title} appliance to store information about your resources, users, and anything else required to manage your virtual enterprise. - -Virtual Thumbnail:: An image in the web interface representing a resource, such as a provider or a virtual machine, showing the resource's properties at a glance. Each virtual thumbnail is divided into quadrants, which provide information about the resource, such as its software and power state. - -Zones:: {product-title} Infrastructure can be organized into zones to configure failover and to isolate traffic. Zones can be created based on your environment. -Zones can be based on geographic location, network location, or function. When first started, new servers are put into the default zone. - -ifdef::cfme[] -[[getting-support]] -=== Getting Support - -If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at http://access.redhat.com. Through the Customer Portal, you can: - -* search or browse through a knowledgebase of technical support articles about Red Hat products -* submit a support case to Red Hat Global Support Services (GSS) -* access other product documentation - -Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. -You can find a list of publicly available mailing lists at https://www.redhat.com/mailman/listinfo. Click on the name of any mailing list to subscribe to that list or to access the list archives. -endif::cfme[] - - - diff --git a/doc-Configuring_High_Availability/common/openstack/adding-an-openstack-cloud-provider.adoc b/doc-Configuring_High_Availability/common/openstack/adding-an-openstack-cloud-provider.adoc deleted file mode 100644 index 6dff19807..000000000 --- a/doc-Configuring_High_Availability/common/openstack/adding-an-openstack-cloud-provider.adoc +++ /dev/null @@ -1,63 +0,0 @@ -{product-title} supports operating with the OpenStack `admin` tenant. -When creating an OpenStack provider in {product-title}, select the OpenStack provider's `admin` user because it is the default administrator of the OpenStack `admin` tenant. -When using the `admin` credentials, a user in {product-title} provisions into the `admin` tenant, and sees images, networks, and instances that are associated with the `admin` tenant. - -[NOTE] -===== -include::tenant-mapping.adoc[] -===== - -[NOTE] -===== -You can set whether {product-title} should use the Telemetry service or Advanced Message Queueing Protocol (AMQP) for event monitoring. If you choose Telemetry, you should first configure the *ceilometer* service on the overcloud to store events. See xref:openstack-events-oc[] for instructions. - -For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-telemetry[OpenStack Telemetry (ceilometer)] in the Red Hat OpenStack Platform _Architecture Guide_. -===== - -. Navigate to menu:Compute[Clouds > Providers]. - -. Click image:1847.png[] (*Configuration*), then click image:1848.png[] (*Add a New Cloud Provider*). - -. Enter a *Name* for the provider. - -. From the *Type* drop down menu select *OpenStack*. - -. Select the appropriate *API Version* from the list. The default is `Keystone v2`. -+ -If you select `Keystone v3`, enter the `Keystone V3 Domain ID` that {product-title} should use. This is the domain of the user account you will be specifying later in the *Default* tab. If domains are not configured in the provider, enter *default*. -+ -[NOTE] -========= -include::osp-keystone-api-v3.adoc[] -========= - -. By default, _tenant mapping_ is disabled. To enable it, set *Tenant Mapping Enabled* to *Yes*. - -. Select the appropriate *Zone* for the provider. By default, the zone is set to *default*. -+ -NOTE: For more information, see the definition of host aggregates and availability zones in https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-compute[OpenStack Compute (nova)] in the Red Hat OpenStack Platform _Architecture Guide_. - -. In the *Default* tab, under *Endpoints*, configure the host and authentication details of your OpenStack provider: -.. In *Hostname (or IPv4 or IPv6 address)*, enter the public IP or fully qualified domain name of the OpenStack Keystone service. -+ -NOTE: The hostname required here is also the *OS_AUTH_URL* value in the *~/overcloudrc* file generated by the director (see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#sect-Accessing_the_Overcloud[Accessing the Overcloud] in Red Hat OpenStack Platform _Director Installation and Usage_ or the *~/keystonerc_admin* file generated by Packstack (see https://access.redhat.com/articles/1127153[Evaluating OpenStack: Single-Node Deployment]). -.. In *API Port*, set the public port used by the OpenStack Keystone service. By default, OpenStack uses port 5000 for this. -.. Select the appropriate *Security Protocol* used for authenticating with your OpenStack provider. -.. In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -.. Click *Validate* to confirm {product-title} can connect to the OpenStack provider. - -. Next, configure how {product-title} should receive events from the OpenStack provider. Click the *Events* tab in the *Endpoints* section to start. -* To use the Telemetry service of the OpenStack provider, select *Ceilometer*. Before you do so, the provider must first be configured accordingly. See xref:openstack-events-oc[] for details. -* If you prefer to use the AMQP Messaging bus instead, select *AMQP*. When you do: - In *Hostname (or IPv4 or IPv6 address)* (of the *Events* tab, under *Endpoints*), enter the public IP or fully qualified domain name of the AMQP host. -** In the *API Port*, set the public port used by AMQP. By default, OpenStack uses port 5672 for this. -** In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -** Click *Validate* to confirm the credentials. - -. Click *Add* after configuring the cloud provider. - -[NOTE] -==== -To collect inventory and metrics from an OpenStack environment, the {product-title} appliance requires that the adminURL endpoint for the OpenStack environment be on a non-private network. -Hence, the OpenStack adminURL endpoint should be assigned an IP address other than `192.168.x.x`. Additionally, all the Keystone endpoints must be accessible, otherwise refresh will fail. -==== diff --git a/doc-Configuring_High_Availability/common/openstack/adding-an-openstack-infrastructure-provider.adoc b/doc-Configuring_High_Availability/common/openstack/adding-an-openstack-infrastructure-provider.adoc deleted file mode 100644 index a5e8cf22b..000000000 --- a/doc-Configuring_High_Availability/common/openstack/adding-an-openstack-infrastructure-provider.adoc +++ /dev/null @@ -1,57 +0,0 @@ -After initial installation and creation of a {product-title} environment, add an OpenStack infrastructure provider to the appliance. {product-title} supports operating with the OpenStack `admin` tenant. -When creating an OpenStack infrastructure provider in {product-title}, select the OpenStack infrastructure provider's `admin` user because it is the default administrator of the OpenStack `admin` tenant. -When using the `admin` credentials, a user in {product-title} provisions into the `admin` tenant, and sees images, networks, and instances that are associated with the `admin` tenant. - -[NOTE] -===== -You can set whether {product-title} should use the Telemetry service or Advanced Message Queueing Protocol (AMQP) for event monitoring. If you choose Telemetry, you should first configure the *ceilometer* service on the undercloud to store events. See xref:openstack-events-uc[] for instructions. - -For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-telemetry[OpenStack Telemetry (ceilometer)] in the Red Hat OpenStack Platform _Architecture Guide_. -===== - - -. Navigate to menu:Compute[Infrastructure > Providers]. -. Click image:1847.png[Configuration] (*Configuration*), then click image:1862.png[Add a New Infrastructure Provider] (*Add a New Infrastructure Provider*). -. Enter the *Name* of the provider to add. - The *Name* is how the device is labeled in the console. -. Select *OpenStack Platform Director* from the *Type* list. - -. Select the *API Version* of your OpenStack provider's Keystone service from the list. The default is `Keystone v2`. -+ -[NOTE] -========= -include::osp-keystone-api-v3.adoc[] -========= - -. Select the appropriate *Zone* for the provider. By default, the zone is set to *default*. -+ -NOTE: For more information, see the definition of host aggregates and availability zones in https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-compute[OpenStack Compute (nova)] in the Red Hat OpenStack Platform _Architecture Guide_. - -. In the *Default* tab, under *Endpoints*, configure the host and authentication details of your OpenStack provider: -.. Enter the *Host Name or IP address(IPv4 or IPv6)* of the provider. If your provider is an undercloud, use its hostname (see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#sect-Setting_the_Hostname_for_the_System[Setting the Hostname for the System] in Red Hat OpenStack Platform _Director Installation and Usage_ for more details) -.. In *API Port*, set the public port used by the OpenStack Keystone service. By default, OpenStack uses port 5000 for this. -.. Select the appropriate *Security Protocol* used for authenticating with your OpenStack provider. -.. In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -.. Click *Validate* to confirm {product-title} can connect to the OpenStack provider. - -. Next, configure how {product-title} should receive events from the OpenStack provider. Click the *Events* tab in the *Endpoints* section to start. -* To use the Telemetry service of the OpenStack provider, select *Ceilometer*. Before you do so, the provider must first be configured accordingly. See xref:openstack-events-uc[] for details. -* If you prefer to use the AMQP Messaging bus instead, select *AMQP*. When you do: - In *Hostname (or IPv4 or IPv6 address)* (of the *Events* tab, under *Endpoints*), enter the public IP or fully qualified domain name of the AMQP host. -** In the *API Port*, set the public port used by AMQP. By default, OpenStack uses port 5672 for this. -** In the *Username* field, enter the name of an OpenStack user with privileged access (for example, *admin*). Then, provide its corresponding password in the *Password* and *Confirm Password* fields. -** Click *Validate* to confirm the credentials. - -. You can also configure SSH access to all hosts managed by the OpenStack infrastructure provider. To do so, click on the *RSA key pair* tab in the *Endpoints* section. -.. From there, enter the *Username* of an account with privileged access. -.. If you selected *SSL* in *Endpoints > Default > Security Protocol* earlier, use the *Browse* button to find and set a private key. - -. Click *Add* after configuring the infrastructure provider. - - -[NOTE] -==== -{product-title} requires that the `adminURL` endpoint for all OpenStack services be on a non-private network. -Accordingly, assign the adminURL endpoint an IP address of something other than `192.168.x.x`. -The `adminURL` endpoint must be accessible to the {product-title} appliance that is responsible for collecting inventory and gathering metrics from the OpenStack environment. Additionally, all the Keystone endpoints must be accessible, otherwise refresh will fail. -==== diff --git a/doc-Configuring_High_Availability/common/openstack/configure-overcloud-to-store-events.adoc b/doc-Configuring_High_Availability/common/openstack/configure-overcloud-to-store-events.adoc deleted file mode 100644 index ebad6d06c..000000000 --- a/doc-Configuring_High_Availability/common/openstack/configure-overcloud-to-store-events.adoc +++ /dev/null @@ -1,52 +0,0 @@ -By default, the Telemetry service does not store events emitted by other services in a Red Hat OpenStack Platform environment. The following procedure outlines how to enable the Telemetry service on your OpenStack cloud provider to store such events. This ensures that events are exposed to {product-title} when a Red Hat OpenStack Platform environment is added as a cloud provider. - -// . On the director node, edit _undercloud.conf_, and set _store_events_ to _true_. -. Log in to the undercloud host. -. Create an environment file called _ceilometer.yaml_, and add the following contents: -+ ------- -parameter_defaults: - CeilometerStoreEvents: true ------- -+ -. Add the environment file to the _overcloud deploy_ command: -+ ------- -# openstack overcloud deploy --templates -e ~/ceilometer.yaml ------- - -If your OpenStack cloud provider was not deployed through the undercloud, you can also set this manually. To do so: - -. Log in to your Controller node. -. Edit _/etc/ceilometer/ceilometer.conf_, and specify the following option: -+ ------- -store_events = True ------- -+ -. Edit _/etc/heat/heat.conf_, and specify the following options: -+ ------- -notification_driver=glance.openstack.common.notifier.rpc_notifier -notification_topics=notifications ------- -+ -. Edit _/etc/nova/nova.conf_, and specify the following options: -+ ------- -notification_driver=messaging -notification_topics=notifications ------- -+ -. Restart the Compute service and Orchestration services: -+ ------- -# systemctl restart openstack-heat-api.service \ - openstack-heat-api-cfn.service \ - openstack-heat-engine.service \ - openstack-heat-api-cloudwatch.service ------- -+ ------- -# systemctl restart openstack-nova-compute.service ------- diff --git a/doc-Configuring_High_Availability/common/openstack/configure-undercloud-to-store-events.adoc b/doc-Configuring_High_Availability/common/openstack/configure-undercloud-to-store-events.adoc deleted file mode 100644 index 61a5e5f4d..000000000 --- a/doc-Configuring_High_Availability/common/openstack/configure-undercloud-to-store-events.adoc +++ /dev/null @@ -1 +0,0 @@ -To allow {product-title} to receive events from a Red Hat OpenStack Platform environment, you must configure the *notification_driver* option for the Compute service and Orchestration service in that environment. To do so, edit _undercloud.conf_, and set _store_events_ to _true_ before installing the undercloud. See https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#chap-Installing_the_Undercloud[Installing the Undercloud] and https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/single/director-installation-and-usage/#sect-Configuring_the_Director[Configuring the Director] in Red Hat OpenStack Platform _Director Installation and Usage_ for related details. diff --git a/doc-Configuring_High_Availability/common/openstack/osp-keystone-api-v3.adoc b/doc-Configuring_High_Availability/common/openstack/osp-keystone-api-v3.adoc deleted file mode 100644 index d8c7baaf8..000000000 --- a/doc-Configuring_High_Availability/common/openstack/osp-keystone-api-v3.adoc +++ /dev/null @@ -1 +0,0 @@ -With Keystone API v3, domains are used to determine administrative boundaries of service entities in OpenStack. Domains allow you to group users together for various purposes, such as setting domain-specific configuration or security options. For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-identity[OpenStack Identity (keystone)] in the Red Hat OpenStack Platform _Architecture Guide_. diff --git a/doc-Configuring_High_Availability/common/openstack/tenant-mapping.adoc b/doc-Configuring_High_Availability/common/openstack/tenant-mapping.adoc deleted file mode 100644 index 338bcdbd3..000000000 --- a/doc-Configuring_High_Availability/common/openstack/tenant-mapping.adoc +++ /dev/null @@ -1,3 +0,0 @@ -When adding an OpenStack cloud or infrastructure provider, you can enable _tenant mapping_ in {product-title} to map any existing tenants from that provider. This means {product-title} will create new cloud tenants to match each of existing OpenStack tenants; each new cloud tenant and its corresponding OpenStack tenant will have identical user memberships, quotas, access/security rules, and resources assignments. - -During a provider refresh, {product-title} will also check for any changes to the tenant list in OpenStack. {product-title} will create new cloud tenants to match any new tenants, and delete any cloud tenants whose corresponding OpenStack tenants no longer exist. {product-title} will also replicate any changes to OpenStack tenants to their corresponding cloud tenants. diff --git a/doc-Configuring_High_Availability/common/osp-keystone-api-v3.adoc b/doc-Configuring_High_Availability/common/osp-keystone-api-v3.adoc deleted file mode 100644 index d8c7baaf8..000000000 --- a/doc-Configuring_High_Availability/common/osp-keystone-api-v3.adoc +++ /dev/null @@ -1 +0,0 @@ -With Keystone API v3, domains are used to determine administrative boundaries of service entities in OpenStack. Domains allow you to group users together for various purposes, such as setting domain-specific configuration or security options. For more information, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/architecture-guide/chapter-1-components#comp-identity[OpenStack Identity (keystone)] in the Red Hat OpenStack Platform _Architecture Guide_. diff --git a/doc-Configuring_High_Availability/common/policies-assigning-profiles-to-infra-hosts.adoc b/doc-Configuring_High_Availability/common/policies-assigning-profiles-to-infra-hosts.adoc deleted file mode 100644 index b96b4ec87..000000000 --- a/doc-Configuring_High_Availability/common/policies-assigning-profiles-to-infra-hosts.adoc +++ /dev/null @@ -1,9 +0,0 @@ -. Navigate to menu:Compute[Infrastructure > Providers], verify the provider you need to assign the policy profiles to. - -. Click image:../images/1941.png[image] (*Policy*), and then click image:../images/1851.png[image](*Manage Policies*). - -. From the *Select Policy Profiles* area, you can click on the triangle next to a desired policy profile to expand it and see its member policies. - -. Check the policy profiles you require to apply to the provider. It turns blue to show its assignment state has changed. - -. Click *Save*. diff --git a/doc-Configuring_High_Availability/common/policies-creating-profiles.adoc b/doc-Configuring_High_Availability/common/policies-creating-profiles.adoc deleted file mode 100644 index aae8d67d0..000000000 --- a/doc-Configuring_High_Availability/common/policies-creating-profiles.adoc +++ /dev/null @@ -1,19 +0,0 @@ -. Navigate to menu:Control[Explorer]. - -. Click on the *Policy Profiles* accordion, then click image:../images/1847.png[image] (*Configuration*), then image:../images/1862.png[image] (*Add a New Policy Profile*). - -. In the *Basic Information* area, type in a unique description for the policy profile. -+ -image:../images/1931.png[image] - -. From *Available Policies* in the *Policy Selection* area select all the policies you need to apply to this policy profile. Use the `Ctrl` key to select multiple policies. -+ -image:../images/1930.png[image] - -. Click image:../images/1876.png[image] to add the *Policies*. -+ -image:../images/1929.png[image] - -. Add to the *Notes* area if required. - -. Click *Add*. diff --git a/doc-Configuring_High_Availability/common/policies-creating-vm-control-policy.adoc b/doc-Configuring_High_Availability/common/policies-creating-vm-control-policy.adoc deleted file mode 100644 index ebfa06f91..000000000 --- a/doc-Configuring_High_Availability/common/policies-creating-vm-control-policy.adoc +++ /dev/null @@ -1,33 +0,0 @@ -. Navigate to menu:Control[Explorer]. -. Expand the *Policies* accordion, and click *Control Policies*. -. Select *Vm Control Policies*. -. Click image:../images/1847.png[image] (*Configuration*), then image:../images/1862.png[image] (*Add a New VM and Instance Control Policy*). -. Enter a *Description*. This will be the name given to your VM control policy. -. Uncheck *Active* if you do not want this policy processed even when assigned to a resource. -. Optionally, enter *Scope* (you can also create a scope as part of a condition, or not use one at all). If the virtual machine is not included in the scope, the assigned action will not run. -+ -You can use the drop-down below the image:../images/1863.png[image] (*Commit expression element changes*) icon to create an expression for the *Scope*. {product-title_short} will generate drop-downs containing relevant options depending on your choices. Click image:../images/1863.png[image] (*Commit expression element changes*) to add the scope. - - - -. Enter *Notes* if required. -. Click *Add*. The policy is added and listed under *Vm Control Policies* in the *Policies* accordion. -. Select the newly-added VM control policy. You can now associate events, conditions, and actions with the policy. -. Click image:../images/1847.png[image] (*Configuration*), then image:../images/1851.png[image] (*Edit this Policy’s Event assignments*). -. Under *VM Operation*, select *VM Analysis Start*. -. Click *Save*. -. Click the *VM Analysis Start* event to configure actions. -. Click image:../images/1847.png[image] (*Configuration*), then image:../images/1851.png[image] (*Edit Actions for this Policy Event*). -. In *Order of Actions if ALL Conditions are True*, select the action created in xref:assign-profile-analysis-task-action[] from the *Available Actions* list. This action will take place if the resources meet the conditions of the policy. -+ -image:../images/edit-action.png[image] -+ -[NOTE] -==== -Each selected action can be executed synchronously or asynchronously; a synchronous action will not start until the previous synchronous action is completed, while an asynchronous action allows the next action to start whether or not the first action has completed. Also, at least one {product-title} server in the {product-title} zone must have the notifier server role enabled for the trap to be sent. -==== -+ -. Click (image:../images/1876.png[image]) which will move the action to *Selected Actions*. The selected action is set to (S) Synchronous by default. From *Selected Actions*, select the action, then: -* Click *A* (Set selected Actions to Asynchronous) to make it asynchronous. -* Click *S* (Set selected Actions to Synchronous) to make it synchronous. If creating a synchronous action, use the up and down arrows to identify in what order you want the actions to run. -. Click *Save*. diff --git a/doc-Configuring_High_Availability/common/policies-intro.adoc b/doc-Configuring_High_Availability/common/policies-intro.adoc deleted file mode 100644 index e9a39042a..000000000 --- a/doc-Configuring_High_Availability/common/policies-intro.adoc +++ /dev/null @@ -1,15 +0,0 @@ -Policies are used to manage your virtual environment. There are two -types of policies available: compliance and control. Compliance policies -are used to harden your virtual infrastructure, making sure that your -security requirements are adhered to. Control policies are used to check -for a specific condition and perform an action based on the outcome. For -example: - -* Prevent virtual machines from running without an administrator -account. -* Prevent virtual machines from starting if certain patches are not -applied. -* Configure the behavior of a production virtual machine to only start -if it is running on a production host. -* Force a SmartState Analysis when a host is added or removed from a -cluster. diff --git a/doc-Configuring_High_Availability/common/provider-ose-add-container.adoc b/doc-Configuring_High_Availability/common/provider-ose-add-container.adoc deleted file mode 100644 index 8ba45756b..000000000 --- a/doc-Configuring_High_Availability/common/provider-ose-add-container.adoc +++ /dev/null @@ -1,17 +0,0 @@ -. Navigate to menu:Compute[Containers > Providers]. -. Click image:1847.png[Configuration] (*Configuration*), then click image:1862.png[Add a New Containers Provider] (*Add a New Containers Provider*). -. Enter a *Name* for the provider. -. From the *Type* list, select *OpenShift Enterprise*. -. Enter the appropriate *Zone* for the provider. By default, the zone is set to `default`. -. Enter the *Hostname or IP address* of the provider. -+ -[IMPORTANT] -==== -The *Hostname* must use a unique fully qualified domain name. -==== -+ -. Enter the *Port* of the provider. - The default port is `8443`. -. Under *Credentials*, enter the token in the *Token* field. This is the token obtained earlier in xref:Obtaining_OpenShift_Enterprise_Management_Token[]. -* Click *Validate* to confirm that the {product-title} can connect to the OpenShift Enterprise provider using the provided token. -. Click *Add*. diff --git a/doc-Configuring_High_Availability/common/provider-ose-mgt-token-3_1.adoc b/doc-Configuring_High_Availability/common/provider-ose-mgt-token-3_1.adoc deleted file mode 100644 index 405f0d208..000000000 --- a/doc-Configuring_High_Availability/common/provider-ose-mgt-token-3_1.adoc +++ /dev/null @@ -1,18 +0,0 @@ -Open a terminal and perform the following: - -. To obtain the `management` service account token name, run the following command:: - - # oc describe sa -n management-infra management-admin - ... - Tokens: management-admin-token-0f3fh - management-admin-token-q7a87 - -. Select one of the tokens and run the following command to retrieve the full token output: - - # oc describe secret -n management-infra management-admin-token-0f3fh - ... - Data - ==== - token: eyJhbGciOiJSUzI1NiI... -+ -Replace `management-admin-token-0f3fh` with the name of your token. diff --git a/doc-Configuring_High_Availability/common/provider-ose-mgt-token-3_2.adoc b/doc-Configuring_High_Availability/common/provider-ose-mgt-token-3_2.adoc deleted file mode 100644 index 371120ec7..000000000 --- a/doc-Configuring_High_Availability/common/provider-ose-mgt-token-3_2.adoc +++ /dev/null @@ -1,4 +0,0 @@ -Open a terminal and run the following command: - - # oc sa get-token -n management-infra management-admin - eyJhbGciOiJSUzI1NiI... diff --git a/doc-Configuring_High_Availability/common/provisioning-dialogs-customization.adoc b/doc-Configuring_High_Availability/common/provisioning-dialogs-customization.adoc deleted file mode 100644 index e8f40c026..000000000 --- a/doc-Configuring_High_Availability/common/provisioning-dialogs-customization.adoc +++ /dev/null @@ -1,11 +0,0 @@ -The default set of provisioning dialogs shows all possible options. However, {product-title} also provides the ability to customize which tabs and fields are shown. You can decide what fields are required to submit the provisioning request or set default values. - -For each type of provisioning, there is a dialog that can be created to adjust what options are presented. While samples are provided containing all possible fields for provisioning, you can remove what fields are shown. However, you cannot add fields or tabs. - -Edit the dialogs to: - -. Hide or show provisioning tabs. -. Hide or show fields. If you hide an attribute, the default will be used, unless you specify otherwise. -. Set default values for a field. -. Specify if a field is required to submit the request. -. Create custom dialogs for specific users. diff --git a/doc-Configuring_High_Availability/common/provisioning-requests-keypairs.adoc b/doc-Configuring_High_Availability/common/provisioning-requests-keypairs.adoc deleted file mode 100644 index 38381fe3c..000000000 --- a/doc-Configuring_High_Availability/common/provisioning-requests-keypairs.adoc +++ /dev/null @@ -1,21 +0,0 @@ - -Key pairs allow you to manage SSH access between a user and provisioned instance. For more information about key pairs in OpenStack, see https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/instances-and-images-guide/chapter-3-virtual-machine-instances#section-manage-keypair[Manage Key Pairs] from the https://access.redhat.com/documentation/en/red-hat-openstack-platform/8/instances-and-images-guide/instances-and-images-guide[Red Hat OpenStack Platform Instances and Images Guide]. - -To manage key pairs, navigate to menu:Compute[Clouds > Key Pairs]. From there, you can view a list of available key pairs. Click on a key pair to view its details. - -To create a new key pair: - -. Navigate to menu:Compute[Clouds > Key Pairs]. - -. Click image:1847.png[](*Configuration*), image:2345.png[](*Add a new Key Pair*). - -. Enter a *Name* for the key pair. - -. If you want to use a public key, copy its contents into the *Public Key (optional)* field. - -. Select which cloud provider on which to create the key pair. The key pair will then be available for use by instances in that provider. - -. Click *Add*. - -// ddomingo -// TODO: NEED TO add steps for using keypair info for streamlining SSH access to instance that uses a keypair. When creating a keypair in OpenStack, a downloadable PEM key is created that you can immediately use in accessing the instance via SSH. No such PEM key is made available when creating key pairs via CFME. diff --git a/doc-Configuring_High_Availability/common/provisioning-requests-openstack.adoc b/doc-Configuring_High_Availability/common/provisioning-requests-openstack.adoc deleted file mode 100644 index e75f51401..000000000 --- a/doc-Configuring_High_Availability/common/provisioning-requests-openstack.adoc +++ /dev/null @@ -1,53 +0,0 @@ - -. Navigate to menu:Compute[Clouds > Instances]. - -. Click image:2007.png[](*Lifecycle*), then click image:1862.png[](*Provision Instances*). - -. Select an OpenStack image from the list presented. These images must be available on your OpenStack provider. - -. Click *Continue*. - -. On the *Request* tab, enter information about this provisioning request. In *Request Information*, type in at least a first and last name and an email address. This email is used to send the requester status emails during the provisioning process for items such as auto-approval, quota, provision complete, retirement, request pending approval, and request denied. The other information is optional. If the {product-title} Server is configured to use LDAP, you can use the *Look Up* button to populate the other fields based on the email address. -+ -[NOTE] -==== -Parameters with a * next to the label are required to submit the provisioning request. To change the required parameters, see xref:provisioning-dialogs-customizing[]. -==== -+ -. Click the *Purpose* tab to select the appropriate tags for the provisioned instance. -. Click the *Catalog* tab for basic instance options. -.. To change the image to use as a basis for the instance, select it from the list of images. -.. Select the *Number of Instances* to provision. -.. Type a *Instance Name* and *Instance Description*. - -. Click the *Environment* tab to select the instance's *Tenant*, *Availabilty Zones*, *Cloud Network*, *Security Groups*, and *Public IP Address*. If no specific Tenant is required, select the *Choose Automatically* checkbox. - -. Click the *Properties* tab to set provider options such as flavors and security settings. -.. Select a flavor from the *Instance Type* list. -.. Select a *Guest Access Key Pair* for access to the instance. For more information about key pairs, see xref:provision-keypairs[]. - -. Click the *Volumes* tab to provision any volumes with the instance. Volumes are useful for augmenting ephemeral storage of instances with persistent, general-purpose block storage: -.. Fill in the *Volume Name* and *Size (gigabytes)* fields. -.. If you want the volume to be deleted once the instance terminates (thereby making it non-persistent), check *Delete on Instance Terminate*. -.. To provision and add multiple volumes to the instance, click *Add Volume*. Doing so will add new fields you can fill in. -+ -For more information about persistent storage in OpenStack, see the Red Hat OpenStack Platform _Storage Guide_. - -. Click the *Customize* tab to set additional instance options. -.. Under *Credentials*, enter a *Root Password* for the *root* user access to the instance. -.. Enter a *IP Address Information* for the instance. Leave as *DHCP* for automatic IP assignment from the provider. -.. Enter any *DNS* information for the instance if necessary. -.. Select a *Customize Template* for additional instance configuration. Select from the Cloud-Init scripts stored on your appliance. -. Click the *Schedule* tab to set the provisioning and retirement date and time. -.. In *Schedule Info*, choose whether the provisioning begins upon approval, or at a specific time. If you select *Schedule*, you will be prompted to enter a date and time. -.. In *Lifespan*, select whether to power on the instances after they are created, and whether to set a retirement date. If you select a retirement period, you will be prompted for when to receive a retirement warning. -. Click *Submit*. - -The provisioning request is sent for approval. For the provisioning to begin, a user with the admin, approver, or super admin account role must approve the request. The admin and super admin roles can also edit, delete, and deny the requests. You will be able to see all provisioning requests where you are either the requester or the approver. - -After submission, the appliance assigns each provision request a *Request ID*. If an error occurs during the approval or provisioning process, use this ID to locate the request in the appliance logs. The Request ID consists of the region associated with the request followed by the request number. As regions define a range of one trillion database IDs, this number can be several digits long. - -*Request ID Format* - -Request 99 in region 123 results in Request ID 123000000000099. - diff --git a/doc-Configuring_High_Availability/common/reports-categories.adoc b/doc-Configuring_High_Availability/common/reports-categories.adoc deleted file mode 100644 index dafe1bbae..000000000 --- a/doc-Configuring_High_Availability/common/reports-categories.adoc +++ /dev/null @@ -1,16 +0,0 @@ -* *Configuration Management*: hardware, application, network, service, user account, operating system, and snapshot information for all of your items. -* *Migration Readiness*: information related to items required to migrate a virtual machine. -* *Operations*: free space on registered and unregistered virtual machines, power states for virtual machines, and SmartState analysis status. -+ -This category also provides reports relating to the operation of {product-title}, such as user IDs and snapshots taken by {product-title}. -* *VM Sprawl*: usage information and disk waste. -* *Relationships*: virtual machine, folder, and cluster relationships. -* *Events*: operations and configuration management events. -* *Performance by Asset Type*: performance of your virtual infrastructure. -+ -You must be capturing capacity and utilization data to get this information. -* *Running Processes*: information on processes running on a virtual machine. -+ -You must have domain credentials entered for the zone to collect the info for these reports, and the virtual machine must have been analyzed at least once. -* *Trending*: projections of datastore capacity, along with host CPU and memory use. -* *Provisioning*: provisioning activity based on the approver, datastore, requester, and virtual machine. diff --git a/doc-Configuring_High_Availability/common/reports-generate-single.adoc b/doc-Configuring_High_Availability/common/reports-generate-single.adoc deleted file mode 100644 index ca1b9cef1..000000000 --- a/doc-Configuring_High_Availability/common/reports-generate-single.adoc +++ /dev/null @@ -1,8 +0,0 @@ -. Navigate to menu:Cloud Intel[Reports] -. Click the *Reports* accordion and select the report you want to view. -. Click image:1847.png[] (*Queue*). -. The report generation is placed on the queue and its status shows in the reports page. -+ -image:2274.png[] -. Click image:2106.png[] *(Reload current display)* to update the status. -. When a report has finished generating, click on its row to view it. diff --git a/doc-Configuring_High_Availability/common/service-dialog-creation.adoc b/doc-Configuring_High_Availability/common/service-dialog-creation.adoc deleted file mode 100644 index be360b773..000000000 --- a/doc-Configuring_High_Availability/common/service-dialog-creation.adoc +++ /dev/null @@ -1,76 +0,0 @@ -. Navigate to menu:Automate[Customization]. -. Click the *Service Dialogs* accordion. -. Click image:1847.png[](*Configuration*), and then image:1862.png[](*Add a new Dialog*). -. In *Dialog Information*, type in a *Label* and *Description*. Check the boxes for the buttons you want available at the bottom of the dialog form. The description will appear as hover text. -+ -As you type in the *Label* of the dialog, it should appear in the *Dialog* pane on the left. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Tab to this Dialog*). -.. Type in a *Label* and *Description* for this tab. -+ -As you type in the *Label* of the tab, it should appear in the *Dialog* pane on the left under the dialog you are creating. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Box to this Tab*). -.. Type in a *Label* and *Description* for this box. -+ -As you type in the *Label* of the box, it should appear in the *Dialog* pane on the left under the tab you are creating. -. Add an element to this box. Elements are controls that accept input. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Element to this Box*). -.. Type in a *Label*, *Name*, and *Description* for this element. -+ -[IMPORTANT] -==== -*Name* must use only alphanumeric characters and underscores without spaces. It is also used to retrieve the value of this element in the method used with the dialog and must start with *dialog_service_type* -==== -+ -.. Select a *Type* for an element type. All *Type* options have a *Required* and *Default Value* field. Check *Required* or set *Required* to *true* if the element is required to proceed. You can also specify a default value. The rest of the options presented are based on which type of element you select. -+ -[width="100%",cols="40%,60%",options="header",] -|==== -|Element Types|Additional Info -|Check Box|Check *Default Value* if you want this check box checked by default. -|Date Control|Use *Date Control* to create a field where users can select a date. If you want users to be able to select a date and time, use the *Date/Time Control* option. -|Date/Time Control|Use *Date/Time Control* to create a field where users can select a date and time. Only one *Date Control* or *Date/Time Control* element can be present in a dialog. -|Drop Down Dynamic List|Use *Drop Down Dynamic List* if you want the list options to be created using automate methods. Use *Entry Point (NS/Cls/Inst)* to select an automate instance. Check *Show Refresh Button* to allow users to refresh the list options manually. -|Radio Button|This element type serves the same purpose as *Drop Down List* but displays options using radio buttons. -|Tag Control|Select a *Category* of tags you want assigned to the virtual machines associated with this service dialog. Check *Single Select* if only one tag can be selected. -|Text Area Box|Provides text area for users to type in some text. You can also leave a message to users by typing in the *Default Value* field or leave it as blank. -|Text Box|This element type serves the same purpose as *Text Area Box* with the option to check *Protected* so the text is shown as asterisks (*), instead of plain text. -|==== -+ -. Continue adding the dialog items you need. You can switch between dialogs, tabs, boxes, and elements by selecting their respective labels from the *Dialog* pane on the left. -. Click *Add*. Your dialog should appear in the *Service Dialogs* accordion. - -///////////////////////////////// -. Select the dialog you just created. -. Click image:1847.png[](*Configuration*), and then image:1851.png[](*Edit this Dialog*). -. Add a tab to the dialog. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Tab to this Dialog*). -.. Type in a *Label* and *Description* for this tab. -. Add a box to this tab. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Box to this Tab*). -.. Type in a *Label* and *Description* for this box. -. Add an element to this box. Elements are controls that accept input. -.. Click image:1862.png[](*Add*), then image:1862.png[](*Add a New Element to this Box*). -.. Type in a *Label*, *Name*, and *Description* for this element. -+ -[IMPORTANT] -==== -*Name* must use only alphanumeric characters and underscores without spaces. It is also used to retrieve the value of this element in the method used with the dialog and must start with *dialog_service_type* -==== -+ -.. Select a *Type* for an element type. All *Type* options have a *Required* and *Default Value* field. Check *Required* or set *Required* to *true* if the element is required to proceed. You can also specify a default value. The rest of the options presented are based on which type of element you select. -+ -[width="100%",cols="40%,60%",options="header",] -|==== -|Element Types|Additional Info -|Check Box|Check *Default Value* if you want this check box checked by default. -|Date Control|Use *Date Control* to create a field where users can select a date. If you want users to be able to select a date and time, use the *Date/Time Control* option. -|Date/Time Control|Use *Date/Time Control* to create a field where users can select a date and time. Only one *Date Control* or *Date/Time Control* element can be present in a dialog. -|Drop Down Dynamic List|Use *Drop Down Dynamic List* if you want the list options to be created using automate methods. Use *Entry Point (NS/Cls/Inst)* to select an automate instance. Check *Show Refresh Button* to allow users to refresh the list options manually. -|Radio Button|This element type serves the same purpose as *Drop Down List* but displays options using radio buttons. -|Tag Control|Select a *Category* of tags you want assigned to the virtual machines associated with this service dialog. Check *Single Select* if only one tag can be selected. -|Text Area Box|Provides text area for users to type in some text. You can also leave a message to users by typing in the *Default Value* field or leave it as blank. -|Text Box|This element type serves the same purpose as *Text Area Box* with the option to check *Protected* so the text is shown as asterisks (*), instead of plain text. -|==== -+ -. Click *Save*. -///////////////////////////////// diff --git a/doc-Configuring_High_Availability/common/smartstate-analysis-instances.adoc b/doc-Configuring_High_Availability/common/smartstate-analysis-instances.adoc deleted file mode 100644 index 3a5d093ee..000000000 --- a/doc-Configuring_High_Availability/common/smartstate-analysis-instances.adoc +++ /dev/null @@ -1,14 +0,0 @@ -To manually initiate SmartState analysis on an instance: - -. Navigate to menu:Compute[Clouds > Instances]. -. Click on an instance in the *All Instances by Provider* nsection. -. Click image:1847.png[] (*Configuration*), and then image:1942.png[] (*Perform SmartState Analysis*). A pop-up window will appear to confirm the action. -. Click *OK*. The SmartState analysis will be initiated for the selected instance. - -To manually initiate SmartState analysis on an Infrastructure host: - -. Navigate to menu:Compute[Infrastructure > Providers]. -. Select a node in the *Nodes* section. -. Click image:1847.png[] (*Configuration*), and then image:1942.png[] (*Perform SmartState Analysis*). A pop-up window will appear to confirm the action. -. Click *OK*. The SmartState analysis will be initiated for the selected node. - diff --git a/doc-Configuring_High_Availability/common/smartstate.adoc b/doc-Configuring_High_Availability/common/smartstate.adoc deleted file mode 100644 index d502b8caa..000000000 --- a/doc-Configuring_High_Availability/common/smartstate.adoc +++ /dev/null @@ -1,12 +0,0 @@ - -// might need https://access.redhat.com/documentation/en-US/Red_Hat_CloudForms/2.0/html/Management_Engine_5.1_Settings_and_Operations_Guide/sect-SmartProxy_Affinity.html - -After enabling the required server roles, enable SmartState analysis. See https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/support-matrix/#smart_state_analysis_support[Smart State Analysis Support] (from https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/support-matrix/[Support Matrix]) and https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/managing-providers/#running_a_smartstate_analysis[Running a SmartState Analysis] (from https://access.redhat.com/documentation/en/red-hat-cloudforms/4.1/managing-providers/#running_a_smartstate_analysis[Managing Providers]) for more information. - -Enabling SmartState analysis is similar to xref:cf-caputils[], in that the procedure also involves enabling server roles on a specific server. To do so: - -. Navigate to menu:Settings[Configuration], and select the server to configure from menu:Settings[Zone] in the left pane of the appliance. -. Navigate to the *Server Roles* list in the menu:Server[Server Control] section. From there, set the appropriate SmartState roles to *ON*. Namely: -.. *SmartProxy* -.. *SmartState Analysis* -. Click *Save*. diff --git a/doc-Configuring_High_Availability/common/tenant-mapping.adoc b/doc-Configuring_High_Availability/common/tenant-mapping.adoc deleted file mode 100644 index 338bcdbd3..000000000 --- a/doc-Configuring_High_Availability/common/tenant-mapping.adoc +++ /dev/null @@ -1,3 +0,0 @@ -When adding an OpenStack cloud or infrastructure provider, you can enable _tenant mapping_ in {product-title} to map any existing tenants from that provider. This means {product-title} will create new cloud tenants to match each of existing OpenStack tenants; each new cloud tenant and its corresponding OpenStack tenant will have identical user memberships, quotas, access/security rules, and resources assignments. - -During a provider refresh, {product-title} will also check for any changes to the tenant list in OpenStack. {product-title} will create new cloud tenants to match any new tenants, and delete any cloud tenants whose corresponding OpenStack tenants no longer exist. {product-title} will also replicate any changes to OpenStack tenants to their corresponding cloud tenants. diff --git a/doc-Configuring_High_Availability/miq/common b/doc-Configuring_High_Availability/miq/common new file mode 120000 index 000000000..248927d21 --- /dev/null +++ b/doc-Configuring_High_Availability/miq/common @@ -0,0 +1 @@ +../../common/ \ No newline at end of file diff --git a/doc-Configuring_High_Availability/miq/index.adoc b/doc-Configuring_High_Availability/miq/index.adoc index 97d683eaa..5b0cc48c2 100644 --- a/doc-Configuring_High_Availability/miq/index.adoc +++ b/doc-Configuring_High_Availability/miq/index.adoc @@ -13,11 +13,7 @@ include::common/attributes/miq.adoc[] :miq: :numbered: + include::topics/Overview.adoc[] include::topics/Installation.adoc[] -include::topics/Database_replication.adoc[] -include::topics/Failover_monitor.adoc[] -include::topics/Failover_testing.adoc[] - - - +include::topics/Database_Failover.adoc[]