Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions api/overview/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Authentication tokens:

- Are associated with the user credentials

- Provide the necessary identify for RBAC in subsequent REST API calls
- Provide the necessary identity for RBAC in subsequent REST API calls

- Expire after a certain amount of time with no REST API activity - 10
minutes by default.
Expand Down Expand Up @@ -95,11 +95,11 @@ that time-out much later.

For such environments, it is possible to request a REST API token to
leverage the administrative UI session timeout. This is requested with
the **requester\_type** parameter witih the value **ui** as follows:
the **requester\_type** parameter with the value **ui** as follows:

``` sh
$ curl --user username:password
-i X GET -H "Accept: application/json"
-i -X GET -H "Accept: application/json"
http://localhost:3000/api/auth?requester_type=ui
```

Expand Down
2 changes: 1 addition & 1 deletion api/overview/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ $ curl -i -X GET -H "Accept: application/json"
http://localhost:3000/api/vms
```

The validated users’s group will be in effect for the duration of the
The validated user's group will be in effect for the duration of the
REST API request. Multiple requests can be made as a particular user but
with different authorization groups concurrently.

Expand Down
2 changes: 1 addition & 1 deletion api/overview/bulk_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

While the capability to fetch an individual resource via
/api/:collection/:id is available, fetching multiple resources via a
filtered search is possible but has limitation on GET url limits and is
filtered search is possible but has limitations on GET url limits and is
cumbersome on the filtering syntax.

The Bulk Queries provides this capability by implementing a *query* POST
Expand Down
2 changes: 1 addition & 1 deletion api/overview/crud.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Update, Delete) using the REST API.
For Authentication, we are showing here basic authentication via the
*--user admin:smartvm* credentials argument. For multiple API calls it
is recommended to access the REST API via token based authentication,
please refer the the [Authentication Page](auth.html) for details.
please refer to the [Authentication Page](auth.html) for details.

#### Show a collection of Resources

Expand Down
4 changes: 2 additions & 2 deletions api/overview/filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Where op supports the following operators:
</tbody>
</table>

When strings, value to be quoted in single or double quotes. When
When using strings, values should be quoted in single or double quotes. When
datetimes, only strict comparison operators are supported.

Example Query of VMs named sample\*, created\_on \> 2019-09-01, and return
Expand Down Expand Up @@ -122,4 +122,4 @@ Metadata](../appendices/collection_metadata.html) page.
GET /api/vms?attributes=name,vendor,hardware&filter[]=vendor='vmware'&filter[]=hardware.memory_mb>=8192

Here filtering on the virtual attribute *hardware* including the one
level association *memory\_mb* off hardware.
level association *memory\_mb* of hardware.
10 changes: 5 additions & 5 deletions api/overview/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,12 +222,12 @@ OPTIONS and DELETE.
</tbody>
</table>

There :collection represent specific Appliance entities like services,
There, :collection represents specific Appliance entities like services,
hosts, vms, etc.

## Updating resources

As shown in the above table, there are a couple of way to update
As shown in the above table, there are a couple of ways to update
attributes in a resource. These are:

- Update a resource via the PUT HTTP Method
Expand Down Expand Up @@ -303,14 +303,14 @@ available with the other two methods.
- **204 No Content** - The server has fulfilled the request but does
not need to return an entity-body, and might want to return updated
meta information. This HTTP response is commonly used for the DELETE
requests, as the resource that was deleted does not exists anymore.
requests, as the resource that was deleted does not exist anymore.

### Client Errors

- **400 Bad Request** - The request could not be understood by the
server due to malformed syntax. The client SHOULD NOT repeat the
request without modifications. In REST API this status code should
be returned to client when the client use the wrong combination of
be returned to client when the client uses the wrong combination of
attributes, like expanding the non-existing collection, or using the
pagination parameter incorrectly. Another use-case could be creating
or performing actions on the resource, when the wrong JSON
Expand All @@ -319,7 +319,7 @@ available with the other two methods.
- **401 Unauthorized** - The request requires user authentication. The
response MUST include a *Authenticate* header field containing a
challenge applicable to the requested resource. If the request
include *Authenticate* header, then this HTTP status code might
includes an *Authenticate* header, then this HTTP status code might
indicate that the current user is **not authorized** to perform
given action or to access given resource.

Expand Down
2 changes: 1 addition & 1 deletion api/overview/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ following:
- "pages" metadata which is the total number of pages for the *limit*
specified (or the default 1000).

- "links" metadata section which includes the necessary URL’s for
- "links" metadata section which includes the necessary URLs for
fetching the current page, next and previous pages, as well as the
first and last pages.

Expand Down
6 changes: 3 additions & 3 deletions api/overview/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ For more information on filter\[\] please reference the
### Expanding Collection

While in the JSON serialization example the description says that the
resource might be a list of references to these resource, using the
resources might be a list of references to these resources, using the
**expand** parameter they can be expanded to return a full JSON
serialization of the resource instead:

Expand Down Expand Up @@ -183,8 +183,8 @@ As another example, one can query good details on hosts:

GET /api/hosts/8?attributes=custom_attributes,ext_management_system,resource_pools,storages,vms,hardware

of course, one needs to be careful with queries like these as list of
vms for a host could be quite large.
Of course, one needs to be careful with queries like these as the list of
VMs for a host could be quite large.

Virtual attributes can also be queried from one-to-one relationships via
the dot notation as follows:
Expand Down
10 changes: 5 additions & 5 deletions deployment_planning_guide/_topics/capacity.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ installation of RHEL-OSP and registration to a satellite that has access to both
# . ~/keystonerc_admin
# ceilometer sample-list -m cpu |wc -l

12. Add the configured OpenStack provider to {{ site.data.product.title_short }}. See After adding the provider, capacity, and utilization data for your instances populate in a few minutes.
12. Add the configured OpenStack provider to {{ site.data.product.title_short }}. After adding the provider, capacity and utilization data for your instances will populate in a few minutes.

### Capacity and Utilization Data Collected

Expand Down Expand Up @@ -287,7 +287,7 @@ Capacity and utilization charts for host, clusters, virtual machines, and datast

You can use the data that is collected in the VMDB to plan where you can put more virtual machines. With {{ site.data.product.title_short }}, you can use a reference virtual machine as an example to plan on which hosts and clusters you can place a new virtual machine.

** Note:** For more information about utilization trends and identifying bottlenecks in your environment, see [Data Optimization](../managing_infrastructure_and_inventory/index.html#data-optimization) in Managing Infrastructure and Inventory.
**Note:** For more information about utilization trends and identifying bottlenecks in your environment, see [Data Optimization](../managing_infrastructure_and_inventory/index.html#data-optimization) in Managing Infrastructure and Inventory.

1. Browse to **Optimize > Planning**.
2. From **Reference VM Selection**, use the drop-down menu to select the virtual machine that is most like the one that you want to add.
Expand All @@ -301,11 +301,11 @@ You can use the data that is collected in the VMDB to plan where you can put mor
From the **Source** list, select the type of data to use as the source for your projections. For example, select **Allocation** to calculate based on the current allocation values of each resource (CPU, memory, or disk space) for the reference virtual machine. Use **Reservation** to project based on the current guaranteed value of the specific resource (CPU Speed, CPU count, memory, or disk space) although that amount might not be allocated to the virtual machine at a specific moment in time. Select **Usage** if you want to calculate based on usage history of the reference virtual machine. Use **Manual Input** to enter your own set of parameters for each resource.

4. From **Target Options / Limits**, select if you want to use clusters or hosts as your targets.

![2256](../images/2256.png)

Also, select the limit of how high the projection can go for CPU, memory, and datastore space. If you are targeting hosts, you are able to select a filter for which hosts can be targets.
Also, select the limit of how high the projection can go for CPU, memory, and datastore space. If you are targeting hosts, you are able to select a filter for which hosts can be targets.
5. From Trend Options, select how far back you want to use the trend data for, a Time Profile and Time Zone if applicable. Note that Time Profile will only show if the logged on user has a Time Profile available.
6. Click Submit.

The **Summary** tab shows the best clusters or hosts on which to place the virtual machines. The **Report** tab shows the best fit and statistics on the reference virtual machine in a tabular format. From the **Report** tab, you can also create a PDF of the report or download the data in `txt` or `csv` format.
The **Summary** tab shows the best clusters or hosts on which to place the virtual machines. The **Report** tab shows the best fit and statistics on the reference virtual machine in a tabular format. From the **Report** tab, you can also create a PDF of the report or download the data in `txt` or `csv` format.
10 changes: 5 additions & 5 deletions deployment_planning_guide/_topics/planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ remote region.

The operations initiated from the global region are subject to the
role-based access control (RBAC) rules on the remote region. The user in
the remote region which matches the logged-in users **user ID** will be
the remote region which matches the logged-in user's **user ID** will be
used to enforce RBAC in the target region. The operation will fail on
the remote system if the user does not have the required permissions.

Expand All @@ -173,8 +173,8 @@ organization.

If you do not add any additional tenants, all resources and user
accounts are contained in a single base tenant which is your
{{ site.data.product.title_short }} appliance itself. In {{ site.data.product.title_short }}, is
sometimes referred as 'tenant zero'.
{{ site.data.product.title_short }} appliance itself. In {{ site.data.product.title_short }}, this is
sometimes referred to as 'tenant zero'.

**Tenancy Account Roles.**

Expand All @@ -200,7 +200,7 @@ inside a tenant.
The following two approaches exist for tenancy planning:

- **Tenantless** - You can create a single large tenant, sometimes
referred as 'tenant zero', and perform all your operations in there
referred to as 'tenant zero', and perform all your operations in there
without any subdivision of resources or user accounts.

- **Enterprise model** - A common scenario is to create a single
Expand Down Expand Up @@ -400,4 +400,4 @@ value set for `max_wal_senders`:

**Example:**

`psql -d vmdb_production -c 'show max_wal_senders'
`psql -d vmdb_production -c 'show max_wal_senders'`
7 changes: 4 additions & 3 deletions general_configuration/_topics/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -709,8 +709,9 @@ the required software, you must specify its version in the
provider must be registered to it. For vCenter version 4, the VMware
vCenter Management Webservices must be running.

###### NTP Servers Settings In the **NTP Servers** area, you can
specify the NTP servers to use as source for clock synchronization here.
###### NTP Servers Settings

In the **NTP Servers** area, you can specify the NTP servers to use as source for clock synchronization here.
The NTP settings specified here will override Zone NTP settings. Enter
one NTP server hostname or IP address in each text box.

Expand Down Expand Up @@ -977,7 +978,7 @@ To upload a custom logo to the user interface:

To enable displaying your custom logo, ensure the option to use
configuration settings for the tenant under **Access Control** is set to
`Yes`. See [simpara\_title](#display-custom-settings) for the procedure
`Yes`. See [Displaying the Custom Configuration Settings](#displaying-the-custom-configuration-settings) for the procedure
on how to set the configuration settings.

###### Customizing the Login Background
Expand Down
6 changes: 3 additions & 3 deletions high_availability_guide/_topics/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ the non-database {{ site.data.product.title_short }} appliances.
deployments.

**Warning:**

This configuration is not reversible.

7. Create the database password.
Expand All @@ -83,7 +83,7 @@ database server.

After installing and configuring an empty database-only appliance in
[Installing the Primary Database-Only
Appliance](#installation_primary_db), the steps in this section create
Appliance](#installing-the-primary-database-only-appliance), the steps in this section create
the database schema used by {{ site.data.product.title_short }} on the primary
database-only appliance, and populate the database with the initial
data.
Expand Down Expand Up @@ -185,7 +185,7 @@ the hostname of the primary database-only appliance.
### Configuring the Primary Database-Only Appliance

On the primary database-only appliance you created in [Installing the
Primary Database-Only Appliance](#installation_primary_db), initialize
Primary Database-Only Appliance](#installing-the-primary-database-only-appliance), initialize
the nodes in the database cluster to configure the database replication.
Run these steps from the appliance console:

Expand Down
8 changes: 2 additions & 6 deletions monitoring_alerts_and_reporting/_topics/to_create_an_alert.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,11 @@ more information, see *General Configuration*.

1. If you select **v1**, enter a trap number in the **Trap
Number** field. Enter **1**, **2**, or **3**, based on the
appropriate suffix number in
[table\_title](#snmp-trap-identifiers).
appropriate suffix number in the table below.

2. If you select **v2**, enter a trap object ID in the **Trap
Object ID** field. Enter **info**, **warning**, or
**critical** based on the values in
[table\_title](#snmp-trap-identifiers).
**critical** based on the values in the table below.

| Object ID | Suffix Number Added to PEN | PEN with the Suffix Added |
| --------------------- | -------------------------- | ------------------------- |
Expand All @@ -71,8 +69,6 @@ more information, see *General Configuration*.
| crit, critical, error | 3 | 1.3.6.1.4.1.33482.3 |


SNMP Trap Identifiers

7. Optionally, select **Send a Management Event** to trigger an
automation event:

Expand Down