Skip to content

Commit 08f51ac

Browse files
FryguyFryguy
committed
Convert to Markdown
1 parent 9537b5a commit 08f51ac

File tree

3,404 files changed

+72582
-88839
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,404 files changed

+72582
-88839
lines changed

‎CHANGELOG.md

-28
This file was deleted.

‎_distro_map.yml

-51
This file was deleted.

‎_images/.gitkeep

Whitespace-only changes.

‎_includes/app-self_signed_ca.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Using a Self-Signed CA Certificate
2+
3+
Adding a self-signed Certificate Authority (CA) certificate for SSL
4+
authentication requires additional configuration on OpenStack Platform
5+
and Microsoft System Center Virtual Machine Manager (SCVMM) providers.
6+
7+
<div class="note">
8+
9+
This procedure is not required for OpenShift Container Platform, Red Hat
10+
Virtualization, or middleware manager providers, which have the option
11+
to select **SSL trusting custom CA** as a **Security Protocol** in the
12+
user interface. These steps are needed only for providers without this
13+
option in the user interface.
14+
15+
</div>
16+
17+
Before adding the provider, configure the following:
18+
19+
1. Copy your provider’s CA certificate in PEM format to
20+
`/etc/pki/ca-trust/source/anchors/` on your {{ site.data.product.title_short }}
21+
appliance.
22+
23+
2. Update the trust settings on the appliance:
24+
25+
# update-ca-trust
26+
27+
3. Restart the EVM processes on the server:
28+
29+
# rake evm:restart
30+
31+
The CA certificate is added to the appliance, and you can add the
32+
provider to {{ site.data.product.title_short }}.

‎_includes/appe-appliance-console-cli.md

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
Currently, the `appliance_console_cli` feature is a subset of the full
2+
functionality of the `appliance_console` itself, and covers functions
3+
most likely to be scripted using the command-line interface (CLI).
4+
5+
1. After starting the {{ site.data.product.title }} appliance, log in with a user
6+
name of `root` and the default password of `smartvm`. This displays
7+
the Bash prompt for the root user.
8+
9+
2. Enter the `appliance_console_cli` or `appliance_console_cli --help`
10+
command to see a list of options available with the command, or
11+
simply enter `appliance_console_cli --option <argument>` directly to
12+
use a specific option.
13+
14+
| | |
15+
| ---------------- | ------------------------------------------------------------------------------------------ |
16+
| Option | Description |
17+
| \--region (-r) | region number (create a new region in the database - requires database credentials passed) |
18+
| \--internal (-i) | internal database (create a database on the current appliance) |
19+
| \--dbdisk | database disk device path (for configuring an internal database) |
20+
| \--hostname (-h) | database hostname |
21+
| \--port | database port (defaults to `5432`) |
22+
| \--username (-U) | database username (defaults to `root`) |
23+
| \--password (-p) | database password |
24+
| \--dbname (-d) | database name (defaults to `vmdb_production`) |
25+
26+
Database Configuration Options
27+
28+
| | |
29+
| ----------------- | ---------------------------------------------------------- |
30+
| Option | Description |
31+
| \--key (-k) | create a new v2\_key |
32+
| \--fetch-key (-K) | fetch the v2\_key from the given host |
33+
| \--force-key (-f) | create or fetch the key even if one exists |
34+
| \--sshlogin | ssh username for fetching the v2\_key (defaults to `root`) |
35+
| \--sshpassword | ssh password for fetching the v2\_key |
36+
37+
v2\_key Options
38+
39+
| | |
40+
| --------------------- | ------------------------------------------------------------------------------------------------ |
41+
| Option | Description |
42+
| \--host (-H) | set the appliance hostname to the given name |
43+
| \--ipaserver (-e) | IPA server FQDN |
44+
| \--ipaprincipal (-n) | IPA server principal (default: `admin`) |
45+
| \--ipapassword (-w) | IPA server password |
46+
| \--ipadomain (-o) | IPA server domain (optional). Will be based on the appliance domain name if not specified. |
47+
| \--iparealm (-l) | IPA server realm (optional). Will be based on the domain name of the ipaserver if not specified. |
48+
| \--uninstall-ipa (-u) | uninstall IPA client |
49+
50+
IPA Server Options
51+
52+
<div class="note">
53+
54+
- In order to configure authentication through an IPA server, in
55+
addition to using **Configure External Authentication (httpd)** in
56+
the `appliance_console`, external authentication can be optionally
57+
configured via the `appliance_console_cli` (command-line interface).
58+
59+
- Specifying **--host** will update the hostname of the appliance. If
60+
this step was already performed via the `appliance_console` and the
61+
necessary updates made to `/etc/hosts` if DNS is not properly
62+
configured, the **--host** option can be omitted.
63+
64+
</div>
65+
66+
| | |
67+
| ---------------------------- | ------------------------------------------------------------------------------- |
68+
| Option | Description |
69+
| \--ca (-c) | CA name used for certmonger (default: `ipa`) |
70+
| \--postgres-client-cert (-g) | install certs for postgres client |
71+
| \--postgres-server-cert | install certs for postgres server |
72+
| \--http-cert | install certs for http server (to create certs/httpd\* values for a unique key) |
73+
| \--extauth-opts (-x) | external authentication options |
74+
75+
Certificate Options
76+
77+
<div class="note">
78+
79+
The certificate options augment the functionality of the `certmonger`
80+
tool and enable creating a certificate signing request (CSR), and
81+
specifying `certmonger` the directories to store the keys.
82+
83+
</div>
84+
85+
| | |
86+
| --------------- | ----------------------------------------------------------------------------------- |
87+
| Option | Description |
88+
| \--logdisk (-l) | log disk path |
89+
| \--tmpdisk | initialize the given device for temp storage (volume mounted at `/var/www/miq_tmp`) |
90+
| \--verbose (-v) | print more debugging info |
91+
92+
Other Options
93+
94+
**Example Usage.**
95+
96+
$ ssh [email protected]
97+
98+
To create a new database locally on the server using `/dev/sdb`:
99+
100+
# appliance_console_cli --internal --dbdisk /dev/sdb --region 0 --password smartvm
101+
102+
To copy the v2\_key from a host *some.example.com* to local machine:
103+
104+
# appliance_console_cli --fetch-key some.example.com --sshlogin root --sshpassword smartvm
105+
106+
You could combine the two to join a region where *db.example.com* is the
107+
appliance hosting the database:
108+
109+
# appliance_console_cli --fetch-key db.example.com --sshlogin root --sshpassword smartvm --hostname db.example.com --password mydatabasepassword
110+
111+
To configure external authentication:
112+
113+
# appliance_console_cli --host appliance.test.company.com
114+
--ipaserver ipaserver.test.company.com
115+
--ipadomain test.company.com
116+
--iparealm TEST.COMPANY.COM
117+
--ipaprincipal admin
118+
--ipapassword smartvm1
119+
120+
To uninstall external authentication:
121+
122+
# appliance_console_cli --uninstall-ipa

‎_includes/automate-custom-button-group.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
1. Navigate to menu:Automation\[Automate \> Customization\].
2+
3+
2. Click the **Buttons** accordion.
4+
5+
3. From the **Object Types** tree, select the type of object you want
6+
to create the button group for.
7+
8+
4. Click ![image](/images/1847.png)(**Configuration**),
9+
![image](/images/1862.png) (**Add a new Button Group**).
10+
11+
5. Type in a **Button Group Text** and **Button Group Hover Text**, and
12+
select the **Button Group Image** you want to use.
13+
14+
6. If custom buttons have already been created, assign them to the
15+
button group. If not, see [???](#create-a-custom-button) to create
16+
custom buttons.
17+
18+
7. Click **Add**.

‎_includes/automate-custom-button.md

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
1. Navigate to menu:Automation\[Automate \> Customization\].
2+
3+
2. Click the **Buttons** accordion.
4+
5+
3. From the **Object Types** tree, select the type of object you want
6+
to create the button for.
7+
8+
4. Click **Unassigned Buttons**.
9+
10+
5. Click ![image](/images/1847.png)(**Configuration**), then
11+
![image](/images/1862.png) (**Add a new Button**).
12+
13+
<div class="note">
14+
15+
If ![image](/images/1862.png) (**Add a new Button**) is not
16+
available, that means you have not created a button group for that
17+
object. To continue, create a button group first. See
18+
[???](#create-custom-button-group)
19+
20+
</div>
21+
22+
6. Under the **Options** tab:
23+
24+
1. Select the **Button** type from the list.
25+
26+
2. Enter button **Text** and **Hover Text**, and select the
27+
**Icon** and **Icon Color** to use.
28+
29+
3. Select a **Dialog** if applicable.
30+
31+
4. Check **Open URL** to open a browser window for the custom URL
32+
returned when the button is executed.
33+
34+
5. Choose a **Display For** option for the button.
35+
36+
6. Select a **Submit** parameter to choose how to submit objects to
37+
automate. Selecting *Submit All* will pass all objects at once
38+
when the button is executed, while choosing *One by one* will
39+
run execute the button action each time per object.
40+
41+
7. Under the **Advanced** tab:
42+
43+
1. Set button **Enablement**. Click **Define Expression** to access
44+
the expression editor tool. Enter **Disabled Button Text** to
45+
display when the custom button is disabled.
46+
47+
2. Use **Visibility** to determine button appearance based on a
48+
custom expression. Click **Define Expression** to access the
49+
expression editor tool.
50+
51+
<div class="note">
52+
53+
For more about setting visibility and enablement for a custom
54+
button, see [???](#filtering-actions-custom-buttons).
55+
56+
</div>
57+
58+
3. In **Object Details**, select **Request** from the
59+
`/System/Process/` dropdown. By default, the message is
60+
`create`. Do not change it.
61+
62+
4. Enter a **Request** name for the `/System/Process/Request`
63+
instance.
64+
65+
5. Enter the **Attribute/Value Pairs** fields if applicable.
66+
67+
6. Set **Role Access**. Selecting *\<By Role\>* will display
68+
available roles. Check applicable roles.
69+
70+
8. Click **Add** when you have confirmed that the button accomplishes
71+
the task you want.

‎_includes/cap-util-assign-server-roles.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
1. Click **Configuration**, then select the server to configure from
2+
menu:Settings\[Zone\] in the accordion menu on the left.
3+
4+
2. Navigate to the **Server Roles** list in the menu:Server\[Server
5+
Control\] section. From there, set the required capacity and
6+
utilization roles to **ON**, namely:
7+
8+
1. **Capacity & Utilization Coordinator**
9+
10+
2. **Capacity & Utilization Data Collector**
11+
12+
3. **Capacity & Utilization Data Processor**
13+
14+
3. Click **Save**.
15+
16+
Data collection is enabled immediately. However, the first collection
17+
begins 5 minutes after the server is started, and every 10 minutes after
18+
that. Therefore, the longest the collection takes after enabling the
19+
Capacity & Utilization Collector role is 10 minutes. The first
20+
collection from a particular provider may take a few minutes since
21+
{{ site.data.product.title }} is gathering data points going one month back in time.

‎_includes/cap-util-note-metrics-collection.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
For metrics collection to work properly, you also need to configure
2+
{{ site.data.product.title }} to allow for all three **Capacity & Utilization** server
3+
roles, which are available from the settings menu under
4+
menu:Configuration\[Server \> Server Control\].

0 commit comments

Comments
 (0)