Skip to content

Commit 8fc7e87

Browse files
authored
[HWORKS-1048] Multi-env documentation (logicalclocks#402)
1 parent 86856bc commit 8fc7e87

File tree

84 files changed

+351
-192
lines changed

Some content is hidden

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

84 files changed

+351
-192
lines changed

docs/admin/ha-dr/dr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Backing up service/application metrics and services/applications logs are out of
1212

1313
Apache Kafka and OpenSearch are additional services maintaining state. The OpenSearch metadata can be reconstructed from the metadata stored on RonDB.
1414

15-
Apache Kafka is used in Hopsworks to store the in-flight data that is on its way to the online feature store. In the event of a total loss of the cluster, running jobs with inflight data will have to be replayed.
15+
Apache Kafka is used in Hopsworks to store the in-flight data that is on its way to the online feature store. In the event of a total loss of the cluster, running jobs with in-flight data will have to be replayed.
1616

1717
### Configuration Backup
1818

docs/admin/ldap/configure-server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ cluster definition used to deploy your Hopsworks cluster. This tutorial shows an
66
server for LDAP and Kerberos integration.
77

88
## Prerequisites
9-
An accessable LDAP domain.
9+
An accessible LDAP domain.
1010
A Kerberos Key Distribution Center (KDC) running on the same domain as Hopsworks (Only for Kerberos).
1111

1212
### Step 1: Server Configuration for LDAP
@@ -43,7 +43,7 @@ Go to the payara admin UI and create a new JNDI external resource. The name of t
4343
<figcaption>LDAP Resource</figcaption>
4444
</figure>
4545
46-
This can also be achived by running the bellow asadmin command.
46+
This can also be achieved by running the below asadmin command.
4747
4848
```bash
4949
asadmin create-jndi-resource \

docs/admin/monitoring/services-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ In the OpenSearch dashboard web application you will see by default all the logs
2929

3030
You can filter the logs of a specific service by searching for the term `service:[service name]`. As shown in the picture below, you can search for the _namenode_ logs by querying `service:namenode`.
3131

32-
Currently only the logs of the following services are collected and indexed: Hopsworks web application (called `domain1` in the log entires), namenodes, resource managers, datanodes, nodemanagers, Kafka brokers, Hive services and RonDB. These are the core component of the platform, additional logs will be added in the future.
32+
Currently only the logs of the following services are collected and indexed: Hopsworks web application (called `domain1` in the log entries), namenodes, resource managers, datanodes, nodemanagers, Kafka brokers, Hive services and RonDB. These are the core component of the platform, additional logs will be added in the future.
3333

3434
<figure>
3535
<img src="../../../assets/images/admin/monitoring/services_logs.png" alt="OpenSearch Dashboards with services logs" />

docs/admin/oauth2/create-azure-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Enter a name for the client such as *hopsworks_oauth_client*. Verify the Support
2929
</figure>
3030
</p>
3131

32-
### Step 2: Get the nessary fields for client registration
32+
### Step 2: Get the necessary fields for client registration
3333
In the Overview section, copy the *Application (client) ID field*. We will use it in
3434
[Identity Provider registration](../create-client) under the name *Client id*.
3535

docs/admin/oauth2/create-okta-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ match all groups. See [Group mapping](../create-client/#group-mapping) on how to
5252
<figcaption>Group claim</figcaption>
5353
</figure>
5454

55-
### Step 2: Get the nessary fields for client registration
55+
### Step 2: Get the necessary fields for client registration
5656
After the application is created go back to _Applications_ and click on the application you just created. Use the
5757
_Okta domain_ (_Connection URL_), _client id_ and _client secret_ generated for your app in the
5858
[Identity Provider registration](../create-client) in Hopsworks.

docs/admin/project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You need to be an administrator on a Hopsworks cluster.
1414

1515
## Changing project quotas
1616

17-
You can find the Project management page by clicking on your name, in the top right coner of the navigation bar, and choosing _Cluster Settings_ from the dropdown menu and going to the _Project_ tab.
17+
You can find the Project management page by clicking on your name, in the top right corner of the navigation bar, and choosing _Cluster Settings_ from the dropdown menu and going to the _Project_ tab.
1818

1919
<figure>
2020
<img src="../../assets/images/admin/projects/project_list.png" alt="Project page" />
@@ -53,7 +53,7 @@ Compute quotas represents the amount of compute a project can use to run Spark a
5353

5454
If the Hopsworks cluster is connected to a Kubernetes cluster, Python jobs, Jupyter notebooks and KServe models are not subject to the compute quota. Currently, Hopsworks does not support defining quotas for compute scheduled on the connected Kubernetes cluster.
5555

56-
By default, the compute quota is disabled. Administrators can change this default by changing the following configuration in the [Condiguration](../admin/variables.md) UI and/or the cluster definition:
56+
By default, the compute quota is disabled. Administrators can change this default by changing the following configuration in the [Configuration](../admin/variables.md) UI and/or the cluster definition:
5757
```
5858
hopsworks:
5959
yarn_default_payment_type: [NOLIMIT to disable the quota, PREPAID to enable it]

docs/admin/roleChaining.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before you begin this guide you'll need the following:
1616
To use role chaining the head node need to be able to impersonate the roles you want to be linked to your project. For this you need to create an instance profile with assume role permissions and attach it to your head node. For more details about the creation of instance profile see the [aws documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html). If running in [managed.hopsworks.ai](https://managed.hopsworks.ai) you can also refer to our [getting started guide](../setup_installation/aws/getting_started.md#step-3-creating-instance-profile).
1717

1818
!!!note
19-
To ensure that the Hopsworks users can't use the head node instance profile and impersonate the roles by their own means, you need to ensure that they can't execute code on the head node. This means having all jobs running on worker nodes and using EKS to run jupyter nodebooks.
19+
To ensure that the Hopsworks users can't use the head node instance profile and impersonate the roles by their own means, you need to ensure that they can't execute code on the head node. This means having all jobs running on worker nodes and using EKS to run jupyter notebooks.
2020

2121
```json
2222
{
@@ -58,7 +58,7 @@ For the instance profile to be able to impersonate the roles you need to configu
5858
<figcaption>Example trust-policy document.</figcaption>
5959

6060
### Step 3: Create mappings
61-
Now that the head node can assume the roles we need to configure Hopsworks to deletegate access to the roles on a project base.
61+
Now that the head node can assume the roles we need to configure Hopsworks to delegate access to the roles on a project base.
6262

6363
In Hopsworks, click on your name in the top right corner of the navigation bar and choose _Cluster Settings_ from the dropdown menu.
6464
In the Cluster Settings' _IAM Role Chaining_ tab you can configure the mappings between projects and IAM roles.
45.5 KB
Loading
Loading
Loading

0 commit comments

Comments
 (0)