Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Production guide section restyling #58

Merged
merged 54 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
55f1225
style: local-k3d-installation
DaruZero Mar 8, 2023
77006fb
fix: use % instead of <> for shortcodes in heading
DaruZero Mar 8, 2023
9cb578b
Merge branch 'main' into feat/xxx/restyling
DaruZero Mar 9, 2023
86f7c7e
Merge branch 'main' into feat/xxx/restyling
DaruZero Mar 9, 2023
d60b411
fix: resource shortode use %
DaruZero Mar 9, 2023
d352fef
feat: add tutorial how to use a custom values.yaml
DaruZero Mar 9, 2023
b3a28d4
feat: reference custom values tutorial
DaruZero Mar 9, 2023
cb4ba2a
feat: update tasks shortcode
DaruZero Mar 9, 2023
3e4e0fc
chore: remove tutorials shortcode
DaruZero Mar 9, 2023
807cd7b
fix: update tasks with new archetype
DaruZero Mar 9, 2023
054ceb6
feat: add before install prereq
DaruZero Mar 9, 2023
40699fa
feat: update local-k3d-installation page
DaruZero Mar 9, 2023
4e91182
Merge branch 'main' into feat/xxx/restyling
DaruZero Mar 10, 2023
2ebd590
feat: add access-umh-via-lens includes
DaruZero Mar 10, 2023
d2dc0bb
feat: add import-cluster-config includes
DaruZero Mar 10, 2023
8ad04fe
feat: split and rewrite flatcar installation
DaruZero Mar 10, 2023
41e4ed2
chore: remove old flatcar installation
DaruZero Mar 10, 2023
8713784
feat: add port mapping to `k3d cluster create`
DaruZero Mar 15, 2023
6d3ee9e
Merge branch 'main' into feat/xxx/restyling
DaruZero Mar 15, 2023
4fc3085
feat: add turkish lang
DaruZero Mar 16, 2023
edbd1f8
feat: more generic access-service-outside-cluster page
DaruZero Mar 16, 2023
4477a01
feat: move datatype migration page to administration
DaruZero Mar 16, 2023
7446011
feat: create upgrading archetype
DaruZero Mar 16, 2023
f3ccb0c
feat: upgrade to 0.9.4 guide
DaruZero Mar 16, 2023
4e8ac2f
feat: upgrade to 0.9.5 guide
DaruZero Mar 16, 2023
3b1a244
feat: upgrade to 0.9.6 guide
DaruZero Mar 16, 2023
fecdee5
feat: upgrade to 0.9.7 guide
DaruZero Mar 16, 2023
5de7fe7
feat: upgrade to 0.9.8 guide
DaruZero Mar 16, 2023
29a2aab
feat: upgrade to 0.9.9 guide
DaruZero Mar 16, 2023
c5732c8
feat: upgrade to 0.9.10 guide
DaruZero Mar 16, 2023
2f01187
feat: upgrade to 0.9.11 guide
DaruZero Mar 16, 2023
8ba6c0a
feat: upgrading section index
DaruZero Mar 16, 2023
2fa7b9c
fix: order guides from most recent to oldest
DaruZero Mar 16, 2023
0da06e1
feat: port-forwarding from lens
DaruZero Mar 17, 2023
8ae5f2f
feat: backup-restore-database task
DaruZero Mar 17, 2023
50c3b8c
feat: import-export nodered flow page
DaruZero Mar 17, 2023
2a2aa1a
feat: vernemq-acl page
DaruZero Mar 17, 2023
f878b44
feat: vernemq-acl page
DaruZero Mar 17, 2023
cb2a68b
feat: mqtt broker rbac guide
DaruZero Mar 17, 2023
65e97ea
feat: mqtt-broker pki
DaruZero Mar 17, 2023
abf71f7
Merge branch 'feat/xxx/restyling' of github.com:united-manufacturing-…
DaruZero Mar 17, 2023
dbb5005
style: production guides indexes
DaruZero Mar 17, 2023
6e91edb
Merge branch 'main' into feat/xxx/restyling
DaruZero Mar 17, 2023
2944295
Merge main into feat/xxx/restyling
github-actions[bot] Mar 17, 2023
1821ac2
Merge main into feat/xxx/restyling
github-actions[bot] Mar 17, 2023
fb38a34
Merge main into feat/xxx/restyling
github-actions[bot] Mar 17, 2023
9055b11
feat: add warning for unstable port forwarding
DaruZero Mar 20, 2023
a0d6be2
feat: add backup grafana database step
DaruZero Mar 20, 2023
9866939
fix: change notice to warning
DaruZero Mar 20, 2023
c998718
feat: aliases
DaruZero Mar 20, 2023
f061c94
feat: add kube-context notice
DaruZero Mar 20, 2023
4d19ff8
feat: static ip for flatcar installation
DaruZero Mar 22, 2023
ee46fce
Merge main into feat/xxx/restyling
github-actions[bot] Mar 22, 2023
32ef349
chore: remove customize-umh-installation.md
DaruZero Mar 23, 2023
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
12 changes: 9 additions & 3 deletions umh.docs.umh.app/archetypes/tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,29 @@
title: "{{ replace .Name "-" " " | title }}"
content_type: task
description: |
Add a description of the task here.
This page describes how to
weight: 50
---

<!-- overview -->

## {{% heading "prerequisites" %}}

{{< include "task-tutorial-prereqs.md" >}}
<!-- Use the include shortcode for the prerequisites, depending
on the type of task. For example, if the task happens after installation,
use the {{< include "task-aftinst-prereqs.md" >}} shortcode, and if the
task happens before installation, use the {{< include "task-befinst-prereqs.md" >}}
shortcode. If the task has no prerequisites, delete the {{% heading "prerequisites" %}}
-->

<!-- If you set the minimum_version or maximum_version parameter in the page's
front matter, add the version check shortcode {{< version-check >}}.
-->

<!-- steps -->

<!-- discussion -->
<!-- Optional section, but recommended; write the problem/question in H3 -->
## {{% heading "troubleshooting" %}}

<!-- Optional section; add links to information related to this topic. -->
## {{% heading "whatsnext" %}}
22 changes: 0 additions & 22 deletions umh.docs.umh.app/archetypes/tutorials.md

This file was deleted.

73 changes: 73 additions & 0 deletions umh.docs.umh.app/archetypes/upgrading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: "Upgrade to v{{ .Name }}"
content_type: upgrading
description: "This page describes how to upgrade the United Manufacturing Hub
to version {{ .Name }}"
weight: 1000
---

This page describes how to upgrade the United Manufacturing Hub to version
{{ .Name }}. Before upgrading, remember to backup the
[database](/docs/production-guide/backup_recovery/backup-timescale/),
[Node-RED flows](/docs/production-guide/backup_recovery/import-export-node-red/),
and your cluster configuration.

## Add Helm repo in {{% resource type="lens" name="name" %}}

Check if the UMH Helm repository is added in {{% resource type="lens" name="name" %}}.
To do so, from the top-left menu, select **FIle** > **Preferences** (or press `CTRL + ,`).
Click on the **Kubernetes** tab and check if the **Helm Chart** section contains
the `https://repo.umh.app` repository.

If it doesn't, click the **Add Custom Helm Repo** button and fill in the following
values:

- Helm repo name: {{% resource type="helm" name="repo" %}}
- URL: {{% resource type="helm" name="repo-url" %}}

Then click **Add**.

<!-- Add here any steps needed before deleting the deployments and statefulsets -->

## Clear Workloads

Some workloads need to be deleted before upgrading. This process _do not_ delete
any data. If a workload is missing, it means that it was not enabled in your
cluster, therefore you can skip it.

To delete a resource, you can select it using the box on the left of the
resource name and click the **-** button on the bottom right corner.

1. Open the **Workloads** tab.
2. From the **Deployment** section, delete the following deployments:
- {{% resource type="deployment" name="barcodereader" %}}
- {{% resource type="deployment" name="factoryinsight" %}}
- {{% resource type="deployment" name="kafkatopostgresql" %}}
- {{% resource type="deployment" name="mqttkafkabridge" %}}
- {{% resource type="deployment" name="mqttsimulator" %}}
- {{% resource type="deployment" name="opcuasimulator" %}}
3. From the **StatefulSet** section, delete the following statefulsets:
- {{% resource type="statefulset" name="mqttbridge" %}}
- {{% resource type="statefulset" name="mqttbroker" %}}
- {{% resource type="statefulset" name="nodered" %}}
- {{% resource type="statefulset" name="sensorconnect" %}}

<!-- Add here any steps needed before upgrading the Helm Chart -->

## Upgrade Helm Chart

Now everything is ready to upgrade the Helm chart.

1. Navigate to the **Helm** > **Releases** tab.
2. Select the {{% resource type="helm" name="release" %}} release and click
**Upgrade**.
3. In the **Helm Upgrade** window, make sure that the `Upgrade version` field
contains the version you want to upgrade to.
4. You can also change the values of the Helm chart, if needed.
<!-- Add here any changes needed to the values.yaml -->
5. Click **Upgrade**.

The upgrade process can take a few minutes. The upgrade is complete when the
**Status** field of the release is Deployed.

<!-- Add here any steps needed after upgrading the Helm Chart -->
17 changes: 8 additions & 9 deletions umh.docs.umh.app/content/en/docs/production-guide/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
+++
title = "Production Guide"
menuTitle = "Production Guide"
description = "These pages describe how to move from development to production and how to use the stack in a production environment."
weight = 3000
+++



---
title: Production Guide
menuTitle: Production Guide
description: |
This section contains information about how to use the stack in a production
environment.
weight: 3000
---
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ you just want to see the data in a dashboard and don't need to manupulate it.

## {{% heading "prerequisites" %}}

{{< include "task-tutorial-prereqs.md" >}}
{{< include "task-aftinst-prereqs.md" >}}

### Get the database credentials

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Access Kafka Outside the Cluster"
content_type: task
description: |
This page describes how to access Kafka from outside the cluster.
weight: 21
weight: 22
---

<!-- overview -->
Expand All @@ -15,7 +15,7 @@ You can enable external access from the Kafka configuration.

## {{% heading "prerequisites" %}}

{{< include "task-tutorial-prereqs.md" >}}
{{< include "task-aftinst-prereqs.md" >}}

<!-- steps -->

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ easy to connect them together.

## {{% heading "prerequisites" %}}

{{< include "task-tutorial-prereqs.md" >}}
{{< include "task-aftinst-prereqs.md" >}}

<!-- steps -->

Expand Down
Loading