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 public/omni/cluster-management/etcd-backups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ First of all, check the current overall status of the cluster backup subsystem:
omnictl get etcdbackupoverallstatus
```

If you have freshly created Omni instance, the output will be similar to this:
If you have a freshly created Omni instance, the output will be similar to this:

```shell
NAMESPACE TYPE ID VERSION CONFIGURATION NAME CONFIGURATION ERROR LAST BACKUP STATUS LAST BACKUP ERROR LAST BACKUP TIME CONFIGURATION ATTEMPT
Expand All @@ -22,7 +22,7 @@ The combination of the `CONFIGURATION NAME` and `CONFIGURATION ERROR` fields dis
Currently, Omni supports two backup stores: `local` and `s3`.
These are configured during Omni initialization.
The output above indicates that the backup store is set to use the `s3` store.
However, the s3 configuration itself has not yet been added, so the` CONFIGURATION ERROR` field shows `not initialized`.
However, the s3 configuration itself has not yet been added, so the `CONFIGURATION ERROR` field shows `not initialized`.
The rest of the fields show as empty because no backups have been created yet.

### S3-compatible providers
Expand Down Expand Up @@ -108,7 +108,7 @@ In a few seconds, you can check the status of the backup:
omnictl get etcdbackupstatus -o yaml
```

This command print per-cluster backup status. The output will be similar to this:
This command prints per-cluster backup status. The output will be similar to this:

```yaml
metadata:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ The URL will either contain a randomly-generated alphanumeric prefix, or the use
This feature only works with HTTP services. **Raw TCP or UDP are not supported**.
</Info>

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

### Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Add or remove control plane and worker nodes in Omni.

#### Scale down a cluster

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:
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 ellipsis:

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

Expand Down
2 changes: 1 addition & 1 deletion public/omni/getting-started/create-a-cluster.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This guide shows you how to create a cluster from registered machines.
You may name the cluster, as well specify the version of Talos Linux and Kubernetes that the cluster should be created with. You may also enable optional cluster features, such as [Disk Encryption](../security-and-authentication/omni-kms-disk-encryption) or [Workload Service Proxying](../cluster-management/expose-an-http-service-from-a-cluster).

<Info>
Note that disk encryption can only be enabled during cluster creation. Enabling this checkbox will configure the cluster to use Omni as a [Key Management Server](../security-and-authentication/omni-kms-disk-encryption), and local disk access will not the possible unless the machine is connected to Omni.
Note that disk encryption can only be enabled during cluster creation. Enabling this checkbox will configure the cluster to use Omni as a [Key Management Server](../security-and-authentication/omni-kms-disk-encryption), and local disk access will not be possible unless the machine is connected to Omni.

It is not possible to rename a cluster after it has been created.
</Info>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ When a static machine is not actively being used in a cluster it is turned off t

## Dynamic providers

Dynamic providers create and destroy machines as needed. These are created using other VM platforms such as AWS, VMware and OpenStack. They can also use other infrastructure management solutions such as [Forman](https://theforeman.org/) or [RackN](http://rackn.com/rebar/) which have their own APIs and can provision machines out of a pool of resources.
Dynamic providers create and destroy machines as needed. These are created using other VM platforms such as AWS, VMware and OpenStack. They can also use other infrastructure management solutions such as [Foreman](https://theforeman.org/) or [RackN](http://rackn.com/rebar/) which have their own APIs and can provision machines out of a pool of resources.

Dynamic providers make a request to a resource API and expect machines to be created dynamically and connected to Omni. A [machine class](../omni-cluster-setup/create-a-machine-class) is automatically created for the request which keeps the machines organized and automatically provisioned to a cluster.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The easiest way is to copy it and change the code that interacts with the platfo

This guide explains how Omni dynamically provisions machines through infrastructure providers and how to implement one.

Lets consider we have a `MachineClass` and a `MachineSet` created:
Let's consider we have a `MachineClass` and a `MachineSet` created:

```yaml
metadata:
Expand Down Expand Up @@ -246,7 +246,7 @@ Generate the schematic without additional options.

<Warning>
If `provider.Run` includes `WithEncodeRequestIDsIntoTokens`,
schematic generation will fail, as creating unique join token per machine and ecoding that into schematic is
schematic generation will fail, as creating unique join token per machine and encoding that into schematic is
not allowed by the common library.
</Warning>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create a Kubeconfig for a Kubernetes Service Account
description: Generate a kubeconfig for a Kubernetes Service Account using omnictl for secure, token-based cluster access.
---

To follow this guide, you will need `omnictl` installed and configured. If you haven't done so already, follow the [`omnictl` guide](../getting-started/install-and-configure-omnictl) You will also need also need a cluster created withing Omni.
To follow this guide, you will need `omnictl` installed and configured. If you haven't done so already, follow the [`omnictl` guide](../getting-started/install-and-configure-omnictl) You will also need a cluster created within Omni.

<Info>
Note that Omni also supports [Omni Service Accounts](../omni-cluster-setup/create-an-omni-service-account), which provide authentication to Omni itself. Kubernetes Service Accounts are used to authenticate to a Kubernetes cluster, not Omni.
Expand Down
2 changes: 1 addition & 1 deletion public/omni/omni-cluster-setup/create-a-machine-class.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Create a Machine Class
description: Define a reusable group of machines based on labels and conditions for automated cluster allocation.
---

This guide shows you how to create and a machine class.
This guide shows you how to create a machine class.

<Tabs>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Generate token-based credentials for programmatic access to Omni.
You will need `omnictl` installed and configured to follow this guide. If you haven't done so already, follow the [`omnictl` guide](../getting-started/install-and-configure-omnictl).

<Info>
And Omni service account will create token based authentication for access to Omni. This is separate from access to the clusters managed by Omni. For Kubernetes access, see [Kubernetes Service Accounts](./create-a-kubeconfig-for-a-service-account).
An Omni service account will create token based authentication for access to Omni. This is separate from access to the clusters managed by Omni. For Kubernetes access, see [Kubernetes Service Accounts](./create-a-kubeconfig-for-a-service-account).
</Info>

### Creating the service account
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ You can do this by either:

Note that this is a one-time operation - these kernel arguments will stay the same for all the machines you boot from the generated schematic ID.

After retreiving the Kernel arguments, split them by white spaces, and put them into your request body. Your CURL command should look like the following:
After retrieving the Kernel arguments, split them by white spaces, and put them into your request body. Your CURL command should look like the following:

```bash
curl -X POST https://factory.talos.dev/schematics \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ c. Choose the appropriate image for your machine.

![appropriate image](./images/join-machines-appropriate-image.png)

d. Click Download to begin downloadng the Omni image
d. Click Download to begin downloading the Omni image

</Tab>
<Tab title="CLI">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Sample output:
Start tailing its logs in a separate shell:

```bash
docker logs -f omni-bare-metal-infra-Provider
docker logs -f omni-bare-metal-infra-provider
```

Sample output:
Expand Down Expand Up @@ -175,7 +175,7 @@ At this point, these machines are booted into a special mode of Talos Linux call
* does not allow a configuration to be applied to it
* establishes a secure [SideroLink](https://www.talos.dev/v1.9/talos-guides/network/siderolink) connection to the Omni instance
* runs the [Metal Agent](https://github.com/siderolabs/extensions/tree/v1.9.0/guest-agents/metal-agent) extension which establishes a connection to the provider
* runs the only the required services to be able to further provisioned by the provider
* runs only the required services to be able to further provisioned by the provider
</Info>

## 4. Configuring and accepting the machines in Omni
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Configure Okta for Omni
description: Configure an Okta SAML application to authenticate users into your Omni instance.
---

1. Log in to Otka
1. Log in to Okta
2. Create a new App Integration
3. Select “SAML 2.0”
4. Give the Application a recognizable name (we suggest simply “Omni”)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Only update the fields mentioned in the table below.
| Name ID Value | Primary email |
| Enable single logout | Disabled |

At the bottom of this section, you’ll see an “Attibute configuration" block, here the mappings from Oracle to Omni fields needs to be entered as below. Use the “Add attribute" button to create new ones.
At the bottom of this section, you’ll see an "Attribute configuration" block, here the mappings from Oracle to Omni fields needs to be entered as below. Use the “Add attribute" button to create new ones.

| Name | Name Format | Value | Description |
| --------- | ----------- | ---------- | ------------------------ |
Expand All @@ -45,7 +45,7 @@ Once saved, head to the "Users" configuration section.

Add any users that you wish to have access to Omni.

Once complete, head back to the "SAML SSO Configuation" tab and hit "Download" on the "Identity Provider Metadata" field.
Once complete, head back to the "SAML SSO Configuration" tab and hit "Download" on the "Identity Provider Metadata" field.

A copy of this file needs to be on the host which will run the Omni container as we’ll feed it in to the container at runtime. You can copy paste contents or download/upload the file whichever is easiest. For the remainder of this guide, we’ll assume this file ends up at the following location on your container host: `~/oraclemetadata.xml`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Expand the “Sign On” section at the bottom of the settings page via the “S

<img src="./images/configure-unifi-identity-sign-on-show-more.png" alt=""/>

At the bottom of this section, you’ll see an “Attibute Statements” block, here the mappings from UIIE to Omni fields needs to be entered as below. Use the “Add Another” button to create new ones.
At the bottom of this section, you’ll see an “Attribute Statements” block, here the mappings from UIIE to Omni fields needs to be entered as below. Use the “Add Another” button to create new ones.

<img src="./images/configure-unifi-identity-attribute-statements.png" alt=""/>

Expand Down
2 changes: 1 addition & 1 deletion public/omni/self-hosted/configure-keycloak-for-omni.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ description: Steps to integrate Keycloak with Omni using SAML authentication.

<img src="./images/configure-keycloak-for-omni-predefined-mapper.png" alt=""/>

* The following mappers need to be added because they will be used by Omni will use these attributes for assigning permissions.
* The following mappers need to be added because Omni will use these attributes for assigning permissions.
* X500 email
* X500 givenName
* X500 surname
Expand Down
2 changes: 1 addition & 1 deletion public/omni/self-hosted/run-image-factory-on-prem.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ A custom container registry is required for air-gapped environments or custom Ta

The official Sidero Labs registry has all of the required Talos installation containers, extensions, and tools.

Export the URl for where you will be hosting the Image Factory.
Export the URL for where you will be hosting the Image Factory.

```bash
export FACTORY_URL="http://factory.internal:8080"
Expand Down
2 changes: 1 addition & 1 deletion public/omni/troubleshooting/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The sections are unordered and can be used to troubleshoot your specific situati

Machines connected to Omni can get in states where Omni can no longer cleanly remove them. This may be because the machine is no longer available, the machine has errors, or other reasons.

This may block the ability to delete a cluster as Omni tries to cleanly remove machines before deleting the clutser resoures. Sometimes trying to force delete the machine from the Omni UI also does not remove the machine.
This may block the ability to delete a cluster as Omni tries to cleanly remove machines before deleting the cluster resources. Sometimes trying to force delete the machine from the Omni UI also does not remove the machine.

To delete a machine from Omni via `omnictl` you will first need to identify what SideroLink it is using.

Expand Down
Loading