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

chore: upgrade to docusarus v3 #1914

Merged
merged 20 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
2 changes: 1 addition & 1 deletion docs/api-content/api-docs/1-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ The API rate limits are as follows:
| /v1/overlords | 10 | 5 | 50 |
| /v1/cluster | 10 | 5 | 50 |
| /v1/cloudconfigs | 10 | 5 | 50 |
| /v1/cloudconfigs/{cloudType}/{uid}/machinePools | 10 | 5 | 50 |
| /v1/cloudconfigs/\{cloudType}/\{uid}/machinePools | 10 | 5 | 50 |
| /v1/edgehosts | 10 | 5 | 50 |
| /v1/metrics | 10 | 5 | 50 |
| /v1/system | 10 | 5 | 50 |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/byoos/image-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ The following steps guide you through creating your image. You will create a cus
17. Click on **Next layer** to add the Kubernetes layer.


18. Select the desired Kubernetes distribution and version. Click on the **</\>** button to display the YAML editor.
18. Select the desired Kubernetes distribution and version. Click on the **\</\>** button to display the YAML editor.


19. Complete the remainder of the cluster profile creation wizard by selecting the next cluster profile layers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Use the following steps to learn how to use Palette's image swap functionality.
7. Select a Kubernetes distribution and version.


8. Next, select the code editor button **</\>** to edit the pack YAML configuration. Within the `pack` section's scope, add your `imageSwap` configuration block. Click on **Next layer** to continue.
8. Next, select the code editor button **\</\>** to edit the pack YAML configuration. Within the `pack` section's scope, add your `imageSwap` configuration block. Click on **Next layer** to continue.

<br />

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/clusters/clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,10 +224,10 @@ At times, you may be required to work with the Palette Support Team to troublesh

This message will display on the UI: "The request was sent successfully. The download will be available soon." There is an average wait time of five (5) minutes.

At the end of this short log fetching interval, the message will be displayed on the UI: "The logs archive for {Cluster-name} was created successfully."
At the end of this short log fetching interval, the message will be displayed on the UI: "The logs archive for \{Cluster-name} was created successfully."


5. Click **Download <*cluster-name*> logs** to download the **Logs** folder to your local machine.
5. Click **Download \<*cluster-name*> logs** to download the **Logs** folder to your local machine.


6. Unzip and rename the Logs folder as per the customer's choice.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The following steps will guide you on how to create a cluster profile for Edge.
8. Select **BYOS Edge OS** in the **Pack Name** field and the pack version.


9. Click on the code editor button **</\>** to open up the editor
9. Click on the code editor button **\</\>** to open up the editor

<br />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ Palette uses [NATS](https://nats.io) and gRPC for communication between Palette
| --- | --- | --- | --- |
| `nats.enabled`| Specifies whether to enable the deployment of a NATS load balancer. | Boolean | `true` |
| `nats.internal`| Specifies whether to deploy a load balancer or use the host network. If this value is set to `true`, then the remaining NATS parameters are ignored. | Boolean | `true` |
| `nats.natsUrl`| The NATS URL. This can be a comma separated list of <dns_name:port> mappings for the NATS load balancer service. For example, "message1.dev.spectrocloud.com:4222,message2.dev.spectrocloud.com:4222". This parameter is mandatory if `nats.internal` is set to `false`. If `nats.internal` is set to `true`, you can leave this parameter empty. | String | `""` |
| `nats.natsUrl`| The NATS URL. This can be a comma separated list of \<dns_name:port> mappings for the NATS load balancer service. For example, "message1.dev.spectrocloud.com:4222,message2.dev.spectrocloud.com:4222". This parameter is mandatory if `nats.internal` is set to `false`. If `nats.internal` is set to `true`, you can leave this parameter empty. | String | `""` |
| `nats.annotations`| A map of key-value pairs that specifies load balancer annotations for NATS. You can use annotations to change the behavior of the load balancer and the Nginx configuration. This is an advanced setting. We recommend you consult with your assigned support team representative prior to modification. | Object | `{}` |
| `nats.natsStaticIP`| Specify a static IP address for the NATS load balancer service. If empty, a dynamic IP address will be assigned to the load balancer. | String | `""` |

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/integrations/generic-vm-vsphere.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,7 @@ envs:

## Files

Files present in this section will be added to the pod and will be accessible while executing pre-and-post execution hooks and absolute file path would be '/var/files/<file_name>'.
Files present in this section will be added to the pod and will be accessible while executing pre-and-post execution hooks and absolute file path would be '/var/files/\<file_name>'.

<br />

Expand Down
31 changes: 16 additions & 15 deletions docs/docs-content/integrations/k3s.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,13 @@ To configure a custom OIDC IDP, choose **Custom** when adding the K3s pack to yo
- oidc-username-claim="email"
```
2. Add the following `clientConfig` section that contains OIDC parameters to your Kubernetes YAML file and replace the placeholders with your third-party OIDC IDP details. The `clientConfig` section must be placed at the root level of the YAML file.

```yaml
clientConfig:
oidc-issuer-url: "<OIDC-ISSUER-URL>"
oidc-client-id: "<OIDC-CLIENT-ID>"
oidc-client-secret: "<OIDC-CLIENT-SECRET>"
oidc-extra-scope: profile,email,openid
clientConfig:
oidc-issuer-url: "<OIDC-ISSUER-URL>"
oidc-client-id: "<OIDC-CLIENT-ID>"
oidc-client-secret: "<OIDC-CLIENT-SECRET>"
oidc-extra-scope: profile,email,openid
```

After you have configured the IDP for authentication, you can proceed to create role bindings to configure authorization in your cluster. Refer to [Create Role Bindings](../clusters/cluster-management/cluster-rbac.md#create-role-bindings) for more guidance.
Expand Down Expand Up @@ -210,11 +211,11 @@ To configure a custom OIDC IDP, choose **Custom** when adding the K3s pack to yo
```
2. Add the following `clientConfig` section that contains OIDC parameters to your Kubernetes YAML file and replace the placeholders with your third-party OIDC IDP details. The `clientConfig` section must be placed at the root level of the YAML file.
```yaml
clientConfig:
oidc-issuer-url: "<OIDC-ISSUER-URL>"
oidc-client-id: "<OIDC-CLIENT-ID>"
oidc-client-secret: "<OIDC-CLIENT-SECRET>"
oidc-extra-scope: profile,email,openid
clientConfig:
oidc-issuer-url: "<OIDC-ISSUER-URL>"
oidc-client-id: "<OIDC-CLIENT-ID>"
oidc-client-secret: "<OIDC-CLIENT-SECRET>"
oidc-extra-scope: profile,email,openid
```

After you have configured the IDP for authentication, you can proceed to create role bindings to configure authorization in your cluster. Refer to [Create Role Bindings](../clusters/cluster-management/cluster-rbac.md#create-role-bindings) for more guidance.
Expand Down Expand Up @@ -317,11 +318,11 @@ To configure a custom OIDC IDP, choose **Custom** when adding the K3s pack to yo
```
2. Add the following `clientConfig` section that contains OIDC parameters to your Kubernetes YAML file and replace the placeholders with your third-party OIDC IDP details. The `clientConfig` section must be placed at the root level of the YAML file.
```yaml
clientConfig:
oidc-issuer-url: "<OIDC-ISSUER-URL>"
oidc-client-id: "<OIDC-CLIENT-ID>"
oidc-client-secret: "<OIDC-CLIENT-SECRET>"
oidc-extra-scope: profile,email,openid
clientConfig:
oidc-issuer-url: "<OIDC-ISSUER-URL>"
oidc-client-id: "<OIDC-CLIENT-ID>"
oidc-client-secret: "<OIDC-CLIENT-SECRET>"
oidc-extra-scope: profile,email,openid
```

After you have configured the IDP for authentication, you can proceed to create role bindings to configure authorization in your cluster. Refer to [Create Role Bindings](../clusters/cluster-management/cluster-rbac.md#create-role-bindings) for more guidance.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/integrations/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ Use the following steps to enable Ubuntu Pro.
- **Pack Version** - 20.04 or 22.04


7. Modify the Ubuntu **Pack values** to activate the **Presets** options for the Ubuntu YAML file. Click on the **</\>** button to reveal the YAML editor and expand the **Preset Drawer**.
7. Modify the Ubuntu **Pack values** to activate the **Presets** options for the Ubuntu YAML file. Click on the **\</\>** button to reveal the YAML editor and expand the **Preset Drawer**.
lennessyy marked this conversation as resolved.
Show resolved Hide resolved


<br />
Expand Down Expand Up @@ -687,7 +687,7 @@ Use the following steps to enable Ubuntu Pro.
- **Pack Version** - 20.04 or 22.04


7. Modify the Ubuntu **Pack values** to activate the **Presets** options for the Ubuntu YAML file. Click on the **</\>** button to reveal the YAML editor and expand the **Preset Drawer**.
7. Modify the Ubuntu **Pack values** to activate the **Presets** options for the Ubuntu YAML file. Click on the **\</\>** button to reveal the YAML editor and expand the **Preset Drawer**.


<br />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ The example below shows how to build the Permission Manager auth pack and push t
3. Create a sub-directory called **manifests**.


4. Copy the desired manifest files to the **manifests** directory and reference them in `pack.json` as shown in step 2. If the configurability of the manifest is desired, then the manifest files must be templatized to introduce parameters. For example, _{{.Values.namespace}}_. These parameters are defined with default values in the `values.yaml` file and can be overridden in the cluster profile.
4. Copy the desired manifest files to the **manifests** directory and reference them in `pack.json` as shown in step 2. If the configurability of the manifest is desired, then the manifest files must be templatized to introduce parameters. For example, _\{\{.Values.namespace}}_. These parameters are defined with default values in the `values.yaml` file and can be overridden in the cluster profile.
lennessyy marked this conversation as resolved.
Show resolved Hide resolved

**permission-manager.yaml (partial)**
```yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/registries-and-packs/oci-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ To provision ECR based OCI Authentication make sure that the User's STS Role has
```
## Multi-Region Support for AWS ECR registries:

Palette supports the parameterization of AWS ECR registry endpoint to support cross-region replicated registries. For performance considerations, Helm chart content may be replicated across multiple AWS regions and served to the clusters from within the region of cluster deployment. To support this, the variable “{{.spectro.system.aws.region}}” can be used in the registry endpoint. This variable is substituted at the time of cluster deployment with the region selected for deployment.
Palette supports the parameterization of AWS ECR registry endpoint to support cross-region replicated registries. For performance considerations, Helm chart content may be replicated across multiple AWS regions and served to the clusters from within the region of cluster deployment. To support this, the variable “\{\{.spectro.system.aws.region}}” can be used in the registry endpoint. This variable is substituted at the time of cluster deployment with the region selected for deployment.


**Region Parameter:**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ To ensure Okta issues OIDC tokens with the correct claims, you must create a cus

<br />

17. Click **<-- Back to Authorization Servers** at the top of the page to navigate back to the list of all servers. The authorization server you created is displayed in the list. Select the **Issuer URI** shown and copy it to the clipboard. Save this value as you will use it in a later step.
17. Click **\<-- Back to Authorization Servers** at the top of the page to navigate back to the list of all servers. The authorization server you created is displayed in the list. Select the **Issuer URI** shown and copy it to the clipboard. Save this value as you will use it in a later step.

<br />

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/workspace/workload-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ The following details are required to configure a backup location in AWS:
4. **S3 Bucket** - S3 bucket name must be pre-created on the object-store.


5. **Configuration** - region={region-name},s3ForcePathStyle={true/false},s3Url={S3 URL}. S3 URL need not be provided for AWS S3.
5. **Configuration** - region=\{region-name},s3ForcePathStyle=\{true/false},s3Url=\{S3 URL}. S3 URL need not be provided for AWS S3.


6. **Account Information** - Details of the account which hosts the S3 bucket to be specified as Credentials or STS.
Expand Down
5 changes: 3 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
require("dotenv").config();
const lightCodeTheme = require("prism-react-renderer/themes/oceanicNext");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const themes = require('prism-react-renderer').themes;
const lightCodeTheme = themes.oceanicNext;
const darkCodeTheme = themes.dracula;
const redirects = require("./redirects");
const ArchivedVersions = require('./archiveVersions.json');
const {
Expand Down
Loading