Skip to content

Commit e065e4b

Browse files
committed
docs: fix doc page nesting
- Fixed over nesting of doc pages and image folders - Edited the first part of the docs. Signed-off-by: Amarachi Iheanacho <amarachi.iheanacho@siderolabs.com>
1 parent b749fde commit e065e4b

81 files changed

Lines changed: 121 additions & 125 deletions

File tree

Some content is hidden

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

docs.json

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@
4444
{
4545
"group": "Self Hosted",
4646
"pages": [
47-
"omni/infrastructure-and-extensions/self-hosted/overview",
48-
"omni/infrastructure-and-extensions/self-hosted/deploy-omni-on-prem",
49-
"omni/infrastructure-and-extensions/self-hosted/configure-keycloak-for-omni/configure-keycloak-for-omni",
50-
"omni/infrastructure-and-extensions/self-hosted/how-to-back-up-on-prem-omni-db",
51-
"omni/infrastructure-and-extensions/self-hosted/expose-omni-with-nginx-https"
47+
"omni/infrastructure-and-extensions/self-hosted/overview",
48+
"omni/infrastructure-and-extensions/self-hosted/deploy-omni-on-prem",
49+
"omni/infrastructure-and-extensions/self-hosted/configure-keycloak-for-omni",
50+
"omni/infrastructure-and-extensions/self-hosted/how-to-back-up-on-prem-omni-db",
51+
"omni/infrastructure-and-extensions/self-hosted/expose-omni-with-nginx-https"
5252
]
5353
},
5454
"omni/infrastructure-and-extensions/install-airgapped-omni",
@@ -96,23 +96,24 @@
9696
{
9797
"group": "Security and Authentication",
9898
"pages": [
99-
{
100-
"group": "Using SAML With Omni",
101-
"pages": [
102-
"omni/security-and-authentication/using-saml-with-omni/overview",
103-
"omni/security-and-authentication/using-saml-with-omni/configure-saml-and-acls",
104-
"omni/security-and-authentication/using-saml-with-omni/configure-okta-for-omni/configure-okta-for-omni",
105-
"omni/security-and-authentication/using-saml-with-omni/add-a-user-to-omni-with-saml-enabled/add-a-user-to-omni-with-saml-enabled",
106-
"omni/security-and-authentication/using-saml-with-omni/auto-assign-roles-to-saml-users",
107-
"omni/security-and-authentication/using-saml-with-omni/configure-unifi-identity-enterprise-for-omni/configure-unifi-identity-enterprise-for-omni",
108-
"omni/security-and-authentication/using-saml-with-omni/configure-workspace-one-access-for-omni/configure-workspace-one-access-for-omni",
109-
"omni/security-and-authentication/using-saml-with-omni/how-to-configure-entraid-for-omni"
110-
]
111-
},
99+
{
100+
"group": "Using SAML With Omni",
101+
"pages": [
102+
103+
"omni/security-and-authentication/using-saml-with-omni/overview",
104+
"omni/security-and-authentication/using-saml-with-omni/configure-saml-and-acls",
105+
"omni/security-and-authentication/using-saml-with-omni/configure-okta-for-omni",
106+
"omni/security-and-authentication/using-saml-with-omni/add-a-user-to-omni-with-saml-enabled",
107+
"omni/security-and-authentication/using-saml-with-omni/auto-assign-roles-to-saml-users",
108+
"omni/security-and-authentication/using-saml-with-omni/configure-unifi-identity-enterprise-for-omni",
109+
"omni/security-and-authentication/using-saml-with-omni/configure-workspace-one-access-for-omni",
110+
"omni/security-and-authentication/using-saml-with-omni/how-to-configure-entraid-for-omni"
111+
]
112+
},
112113
"omni/security-and-authentication/authentication-and-authorization",
113114
"omni/security-and-authentication/how-to-manage-acls",
114115
"omni/security-and-authentication/omni-kms-disk-encryption",
115-
"omni/security-and-authentication/rotate-siderolink-join-token/rotate-siderolink-join-token"
116+
"omni/security-and-authentication/rotate-siderolink-join-token"
116117
]
117118
},
118119
{

omni/cluster-management/create-a-hybrid-cluster.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide shows you how to create a cluster consisting of any combination of ba
66

77
Refer to the general guide on creating a cluster to get started. To create a hybrid cluster, navigate to the cluster, then apply the following cluster patch by clicking on "Config Patches", and create a new patch with the target of "Cluster":
88

9-
<img src="./images/create-patch-kubescan-enabled.png" alt="Create Patch"/>
9+
<img src="./images/create-a-hybrid-cluster-create-patch-kubescan-enabled.png" alt="Create Patch"/>
1010

1111
```yaml
1212
machine:

omni/cluster-management/etcd-backups.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ spec:
112112
nanos: 985220192
113113
```
114114

115-
You can also get the overall status of the backup subsystem, where the output will be similar to this:
115+
You can also get the overall status of the backup subsystem:
116116

117117
```yaml
118118
metadata:

omni/cluster-management/expose-an-http-service-from-a-cluster.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You first need to enable the workload service proxying feature on the cluster yo
88

99
If you are creating a new cluster, you can enable the feature by checking the checkbox in the “Cluster Features” section:
1010

11-
<img src="./images/create-a-cluster-http-proxying.png" alt="Enable Workload Service Proxying" />
11+
<img src="./images/expose-an-http-service-create-a-cluster-http-proxying.png" alt="Enable Workload Service Proxying" />
1212

1313
For an existing cluster, simply check the checkbox in the features section of the cluster overview page.
1414

@@ -80,7 +80,7 @@ omni-kube-service-exposer.sidero.dev/label: Sample Nginx
8080
omni-kube-service-exposer.sidero.dev/icon: H4sICB0B1mQAA25naW54LXN2Z3JlcG8tY29tLnN2ZwBdU8ly2zAMvfcrWPZKwiTANWM5015yyiHdDr1kNLZsa0axvKix8/cFJbvNdCRCEvEAPDxQ8/vLSydem+Op7XeVtGCkaHbLftXuNpX8Pax1kveL+UetxY9919erZiWG/k58+/kgvjb7Xonz+Qyn182RP2DZvyjx0OyaYz30x38o8dhemqP43vfdSWi9+DDnCHFuV8O2ksmY/UWKbdNutsPfz9e2OX/pL5U0wghCvqVgqrtTJbfDsL+bzUrhM0F/3MzQGDPjlHIxH9qhaxbrtmueh7d987zbtLvLfDZtz/f1sBWrSj5aD9klhVswwdfWgLNJXR+GL6sgRwSP6QmRd53yELzCCMmRShCjqyFmLOsWwCiIKS01GJOUA0qZHQUby5ZXlsAGjkv8wmuK00A+gDfxoD1DSREQOm0teBdVgOA4wqdY1i0i+AiG4lOGbFEhg7icZWJIgCMz+It1DA/hYDQXScxVjyyohpCprBt7SswylJze49htVNxQjk6xDuSXTAs12OQgUGLWMRenLj4pTsNb11SSde/uPhmbA2U5e6c3qxBiEdhTOhhO77CIwxvJ55p7NVlN1owX+xkOJhUb3M1OTuShAZpQIoK72mtcSF5bwExLoxECjsqzssgIzdMLB2IdiPViApHbsTwhH1KNkIgFHO2tTOB54pjfXu3k4QLechmK9lCGzfm9s0XbQtmWfqa4NB0Oo1lzVtUsx6wjKxtYBcKSMkJOyGzJBbYxBM0aBypZfdBRJyDCz0zNRjXZKw0D/J75KFApFvPVTt73kv/6b0Lr9bqMp/wziz8W9M/pAwQAAA==
8181
```
8282

83-
To expose a service, **only the `omni-kube-service-exposer.sidero.dev/port` annotation is required**.
83+
To expose a service, only the `omni-kube-service-exposer.sidero.dev/port` annotation is required.
8484

8585
Its value **must be a port that is unused** on the nodes, such as by other exposed Services.
8686

@@ -109,23 +109,23 @@ You will notice that the Service you annotated will appear under the “Exposed
109109

110110
Clicking it will open the exposed service in Omni.
111111

112-
<img src="./images/accessing-exposed-service.png" alt="Exposed services" width="500" />
112+
<img src="./images/expose-an-http-service-accessing-exposed-service.png" alt="Exposed services" width="500" />
113113

114114
The URL will either contain a randomly-generated alphanumeric prefix, or the user-defined prefix if the `omni-kube-service-exposer.sidero.dev/prefix` annotation was set.
115115

116116
<Info>
117117
This feature only works with HTTP services. **Raw TCP or UDP are not supported**.
118118
</Info>
119119

120-
The services are only accessible to users **authenticated to Omni and that have at least`Reader`level access** to the cluster containing the Service.
120+
The services are only accessible to users authenticated to Omni and that have at least`Reader`level access to the cluster containing the Service.
121121

122122
### Examples
123123

124124
Some common examples include running cluster services such as monitoring that require Omni access.
125125

126126
#### Grafana
127127

128-
Grafana is a popular dashboarding tool that can be installed as a helm chart and exposed with the following values.yaml.
128+
Grafana is a popular dashboarding tool that can be installed as a helm chart and exposed with the following `values.yaml`.
129129

130130
```
131131
service:
@@ -145,7 +145,7 @@ helm install -f values.yaml grafana grafana/grafana
145145
146146
#### Kubernetes Dashboard
147147
148-
The Kubernetes dashboard can be deployed via helm into a cluster and exposed with the workload proxy using the following values.yaml.
148+
The Kubernetes dashboard can be deployed via helm into a cluster and exposed with the workload proxy using the following `values.yaml`.
149149
150150
```
151151
web:

omni/cluster-management/images/create-patch-kubescan-enabled.png renamed to omni/cluster-management/images/create-a-hybrid-cluster-create-patch-kubescan-enabled.png

File renamed without changes.

omni/cluster-management/images/accessing-exposed-service.png renamed to omni/cluster-management/images/expose-an-http-service-accessing-exposed-service.png

File renamed without changes.

omni/cluster-management/images/create-a-cluster-http-proxying.png renamed to omni/cluster-management/images/expose-an-http-service-create-a-cluster-http-proxying.png

File renamed without changes.

omni/cluster-management/images/scale-cluster-up-or-down.png renamed to omni/cluster-management/images/scale-cluster-up-or-down-destroy.png

File renamed without changes.

omni/cluster-management/scale-a-cluster-up-or-down.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Scale a Cluster Up or Down
66

77
To delete machines in a cluster, click the “Clusters” menu item on the left, then the name of the cluster you wish to delete nodes from. Click the “Nodes” menu item on the left. Now, select “Destroy” from the menu under the elipsis:
88

9-
<img src="./images/scale-cluster-up-or-down.png" alt="Scale your cluster"/>
9+
<img src="./images/scale-cluster-up-or-down-destroy.png" alt="Scale your cluster"/>
1010

1111
The cluster will now scale down.
1212

omni/cluster-management/using-audit-log.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Audit logs are enabled by default for customers on our Omni SaaS.
77
</Info>
88

99
<Info>
10-
#### Enabling the audit log for self-hosted Omni
10+
Enabling the audit log for self-hosted Omni
1111

1212
By default, the audit log is disabled. To enable it, you need to specify the `--audit-log-dir <dir>` when starting the Omni server.
1313

0 commit comments

Comments
 (0)