Skip to content

Commit a52e5dc

Browse files
authored
k8s release docs (#410)
1 parent 9181305 commit a52e5dc

File tree

81 files changed

+797
-5967
lines changed

Some content is hidden

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

81 files changed

+797
-5967
lines changed

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ pointer-events: initial;
185185
</a>
186186
</div>
187187
<div id="w-node-_4a479fbb-90c7-9f47-d439-20aa6a224339-46672785" class="infra">
188-
<a href="./setup_installation/on_prem/hopsworks_installer/">
188+
<a href="./setup_installation/on_prem/contact_hopsworks/">
189189
<img src="images/icons8-database.svg" loading="lazy" alt="" class="infra-icon">
190190
<div class="name_item small">On-premise</div>
191191
</a>
@@ -265,7 +265,7 @@ Hopsworks provides projects as a secure sandbox in which teams can collaborate a
265265
Hopsworks provides a FTI (feature/training/inference) pipeline architecture for ML systems. Each part of the pipeline is defined in a Hopsworks job which corresponds to a Jupyter notebook, a python script or a jar. The production pipelines are then orchestrated with Airflow which is bundled in Hopsworks. Hopsworks provides several python environments that can be used and customized for each part of the FTI pipeline, for example switching between using PyTorch or TensorFlow in the training pipeline. You can train models on as many GPUs as are installed in a Hopsworks cluster and easily share them among users. You can also run Spark, Spark Streaming, or Flink programs on Hopsworks. JupyterLab is also bundled which can be used to run Python and Spark interactively.
266266

267267
## Available on any Platform
268-
Hopsworks is available as a both managed platform in the cloud on AWS, Azure, and GCP, and can be installed on any Linux-based virtual machines (Ubuntu/Redhat compatible), even in air-gapped data centers. Hopsworks is also available as a serverless platform that manages and serves both your features and models.
268+
Hopsworks is available to be installed on a kubernetes cluster in the cloud on AWS, Azure, and GCP, and On-Prem (Ubuntu/Redhat compatible), even in air-gapped data centers. Hopsworks is also available as a serverless platform that manages and serves both your features and models.
269269

270270
## Join the community
271271
- Ask questions and give us feedback in the [Hopsworks Community](https://community.hopsworks.ai/)

docs/js/dropdown.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
document.getElementsByClassName("md-tabs__link")[7].style.display = "none";
2-
document.getElementsByClassName("md-tabs__link")[9].style.display = "none";
1+
document.getElementsByClassName("md-tabs__link")[6].style.display = "none";
2+
document.getElementsByClassName("md-tabs__link")[8].style.display = "none";
33

docs/admin/alert.md renamed to docs/setup_installation/admin/alert.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Cluster Settings from the dropdown menu. In the Cluster Settings' Alerts tab you
1414
manager to send alerts via email, slack or pagerduty.
1515

1616
<figure>
17-
<img src="../../assets/images/alerts/configure-alerts.png" alt="Configure alerts"/>
17+
<img src="../../../assets/images/alerts/configure-alerts.png" alt="Configure alerts"/>
1818
<figcaption>Configure alerts</figcaption>
1919
</figure>
2020

@@ -23,7 +23,7 @@ To send alerts via email you need to configure an SMTP server. Click on the _Con
2323
button on the left side of the **email** row and fill out the form that pops up.
2424

2525
<figure>
26-
<img src="../../assets/images/alerts/smtp-config.png" alt="Configure Email Alerts"/>
26+
<img src="../../../assets/images/alerts/smtp-config.png" alt="Configure Email Alerts"/>
2727
<figcaption>Configure Email Alerts</figcaption>
2828
</figure>
2929

@@ -34,27 +34,27 @@ button on the left side of the **email** row and fill out the form that pops up.
3434
CRAM-MD5, LOGIN or PLAIN.
3535

3636
Optionally cluster wide Email alert receivers can be added in _Default receiver emails_.
37-
These receivers will be available to all users when they create event triggered [alerts](../../user_guides/fs/feature_group/data_validation_best_practices#setup-alerts).
37+
These receivers will be available to all users when they create event triggered [alerts](../../../user_guides/fs/feature_group/data_validation_best_practices#setup-alerts).
3838

3939
### Step 3: Configure Slack Alerts
4040
Alerts can also be sent via Slack messages. To be able to send Slack messages you first need to configure
4141
a Slack webhook. Click on the _Configure_ button on the left side of the **slack** row and past in your
4242
[Slack webhook](https://api.slack.com/messaging/webhooks) in _Webhook_.
4343

4444
<figure>
45-
<img src="../../assets/images/alerts/slack-config.png" alt="Configure slack Alerts"/>
45+
<img src="../../../assets/images/alerts/slack-config.png" alt="Configure slack Alerts"/>
4646
<figcaption>Configure slack Alerts</figcaption>
4747
</figure>
4848

4949
Optionally cluster wide Slack alert receivers can be added in _Slack channel/user_.
50-
These receivers will be available to all users when they create event triggered [alerts](../../user_guides/fs/feature_group/data_validation_best_practices/#setup-alerts).
50+
These receivers will be available to all users when they create event triggered [alerts](../../../user_guides/fs/feature_group/data_validation_best_practices/#setup-alerts).
5151

5252
### Step 4: Configure Pagerduty Alerts
5353
Pagerduty is another way you can send alerts from Hopsworks. Click on the _Configure_ button on the left side of
5454
the **pagerduty** row and fill out the form that pops up.
5555

5656
<figure>
57-
<img src="../../assets/images/alerts/pagerduty-config.png" alt="Configure Pagerduty Alerts"/>
57+
<img src="../../../assets/images/alerts/pagerduty-config.png" alt="Configure Pagerduty Alerts"/>
5858
<figcaption>Configure Pagerduty Alerts</figcaption>
5959
</figure>
6060

@@ -76,7 +76,7 @@ If you are familiar with Prometheus' [Alert manager](https://prometheus.io/docs/
7676
you can also configure alerts by editing the _yaml/json_ file directly.
7777

7878
<figure>
79-
<img src="../../assets/images/alerts/advanced-config.png" alt="Advanced configuration"/>
79+
<img src="../../../assets/images/alerts/advanced-config.png" alt="Advanced configuration"/>
8080
<figcaption>Advanced configuration</figcaption>
8181
</figure>
8282

@@ -93,7 +93,7 @@ global:
9393
...
9494
```
9595

96-
To test the alerts by creating triggers from Jobs and Feature group validations see [Alerts](../../user_guides/fs/feature_group/data_validation_best_practices/#setup-alerts).
96+
To test the alerts by creating triggers from Jobs and Feature group validations see [Alerts](../../../user_guides/fs/feature_group/data_validation_best_practices/#setup-alerts).
9797

9898
The yaml syntax in the UI is slightly different in that it does not allow double quotes (it will ignore the values but give no error).
9999
Below is an example configuration, that can be used in the UI, with both email and slack receivers configured for system alerts.
@@ -144,4 +144,4 @@ receivers:
144144
```
145145
146146
## Conclusion
147-
In this guide you learned how to configure alerts in Hopsworks.
147+
In this guide you learned how to configure alerts in Hopsworks.

docs/admin/audit/audit-logs.md renamed to docs/setup_installation/admin/audit/audit-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Audit logs can be configured from the _Cluster Settings_ Configuration tab.
1717
You can access the _Configuration_ page of your Hopsworks cluster by clicking on your name, in the top right corner, and choosing _Cluster Settings_ from the dropdown menu.
1818

1919
<figure>
20-
<img src="../../../assets/images/admin/audit/audit-log-vars.png" alt="Audit log configuration" />
20+
<img src="../../../../assets/images/admin/audit/audit-log-vars.png" alt="Audit log configuration" />
2121
<figcaption>Audit log configuration</figcaption>
2222
</figure>
2323

docs/admin/auth.md renamed to docs/setup_installation/admin/auth.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ In the **Cluster Settings** _Authentication_ tab you can configure how users aut
3535
[Configure LDAP](../ldap/configure-ldap) and [Configure Kerberos](../ldap/configure-krb).
3636

3737
<figure>
38-
<img src="../../assets/images/admin/auth-config.png" alt="Authentication config" />
38+
<img src="../../../assets/images/admin/auth-config.png" alt="Authentication config" />
3939
<figcaption>Setup Authentication Methods</figcaption>
4040
</figure>
4141

4242
In the figure above we see a cluster with Two-factor authentication disabled, OAuth enabled with one registered
4343
identity provider and LDAP authentication enabled.
4444

4545
## Conclusion
46-
In this guide you learned how to configure authentication methods in Hopsworks.
46+
In this guide you learned how to configure authentication methods in Hopsworks.
File renamed without changes.

docs/admin/ha-dr/ha.md renamed to docs/setup_installation/admin/ha-dr/ha.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ At a high level a Hopsworks cluster can be divided into 4 groups of nodes. Each
1010
Example deployment:
1111

1212
<figure>
13-
<img width="800px" src="../../../assets/images/admin/ha_dr/example_ha_cluster.svg" alt="Example HA deployment"/>
13+
<img width="800px" src="../../../../assets/images/admin/ha_dr/example_ha_cluster.svg" alt="Example HA deployment"/>
1414
<figcaption>Example High Available deployment</figcaption>
1515
</figure>
1616

File renamed without changes.

0 commit comments

Comments
 (0)