Skip to content

Commit

Permalink
[version-3-4] docs: Backport/version 3 4/pr 2031 (#2067)
Browse files Browse the repository at this point in the history
* docs: DOC-1012  ISO 27001 (#2031)

* docs: updated language and added ISO 27001

* docs: fixed broken anchors

* docs: more finding

* docs: compliance image update

* docs: fixed broken achor

* docs: updated index page

* docs: vale feedback

* Optimised images with calibre/image-actions

* Apply suggestions from code review

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: feedback

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* docs: fixed broken anchors

* docs: fixed last broken anchor

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
  • Loading branch information
3 people authored Jan 17, 2024
1 parent 10bdbba commit 890720f
Show file tree
Hide file tree
Showing 41 changed files with 224 additions and 154 deletions.
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 @@ -29,7 +29,7 @@ Palette uses API keys to provide secure API authentication and authorization. Th
* Key: ApiKey
* Value: API key copied from the Palette Console. E.g. QMOI1ZVKVIoW6LM6uXqSWFPsjmt0juvl

[Read More...](/user-management/user-authentication/#usingapikey)
[Read More...](/user-management/user-authentication)
## Requests

All requests are in the `JSON` format. In general, the request payload has three sections: *metadata, spec and status*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Palette [Virtual Clusters](../palette-virtual-clusters/palette-virtual-clusters.

## Prerequisites

* A project or tenant backup location. Refer to the [cluster backup and restore](../cluster-management/backup-restore/backup-restore.md#clusterbackupandrestore) document to learn how to configure a backup location.
* A project or tenant backup location. Refer to the [cluster backup and restore](../cluster-management/backup-restore/backup-restore.md#get-started) document to learn how to configure a backup location.

* Cluster group modification [permissions](../../user-management/palette-rbac/palette-rbac.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags: ["clusters", "cluster management", "backup"]
---


This guide provides instructions for how to add a backup location in Palette using dynamic access credentials. You use the dynamic access credentials to authenticate Palette with the backup location service provider. Refer to the [Backup Location](backup-restore.md#backuplocation) section to learn more about the supported service providers.
This guide provides instructions for how to add a backup location in Palette using dynamic access credentials. You use the dynamic access credentials to authenticate Palette with the backup location service provider. Refer to the [Backup Location](./backup-restore.md#backup-locations-and-credentials) section to learn more about the supported service providers.


Depending on the infrastructure provider, there may be limitations or different prerequisites.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To get started with creating a backup, check out the [Add a Backup Location usin

:::info

If you are using a workspace, refer to the [Manage Palette Workspace](/workspace/workload-features#managepaletteworkspace) guide to learn more about backup and restore actions for a workspace.
If you are using a workspace, refer to the [Manage Palette Workspace](../../../workspace/workload-features.md) guide to learn more about backup and restore actions for a workspace.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ kubectl get role <yourRoleNameHere> --namespace <namespace> --show-kind --export
# Use RBAC With OIDC


This section explains how to use RBAC with OIDC providers. You can apply these steps to all the public cloud providers except [Azure-AKS](/clusters/public-cloud/azure/aks/#configureanazureactivedirectory) and [EKS](/integrations/oidc-eks/) clusters. Azure AKS and AWS EKS require different configurations.
This section explains how to use RBAC with OIDC providers. You can apply these steps to all the public cloud providers except [Azure-AKS](../public-cloud/azure/aks.md) and [EKS](../../integrations/oidc-eks.md) clusters. Azure AKS and AWS EKS require different configurations.

Add the following parameters to your Kubernetes pack when creating a cluster profile.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,20 @@ To get started with an attribute access control through tags, check out the [Cre

- [Cluster Resource Filter](create-add-filter.md)

- [Create Resource Filter](create-add-filter.md#createresourcefilter)
- [Create Resource Filter](create-add-filter.md#create-resource-filter)

- [Add Resource Role](create-add-filter.md#addresourcerole)
- [Add Resource Role](create-add-filter.md#add-resource-role)


- [Palette Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md)

- [Palette Global Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md#paletteglobalresourceroles)
- [Palette Global Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md#palette-global-resource-roles)

- [Palette Custom Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md#palettecustomresourceroles)
- [Palette Custom Resource Roles](../../../user-management/palette-rbac/resource-scope-roles-permissions.md#palette-custom-resource-roles)

- [Create Custom Role](../../../user-management/new-user.md#createcustomrole)
- [Create Custom Role](../../../user-management/new-user.md#create-custom-role)

- [Create New User in Palette](../../../user-management/new-user.md#createanewuser)
- [Create New User in Palette](../../../user-management/new-user.md#create-a-new-user)



Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,17 @@ Upon creating a filter, a display message will pop up to confirm the successful

## Add Resource Role

You can assign the resource filter created, in combination with roles, to a [user](../../../user-management/new-user.md#createanewuser) to enforce access restriction. Palette provisions two types of roles:
You can assign the resource filter created, in combination with roles, to a [user](../../../user-management/new-user.md#create-a-new-user) to enforce access restriction. Palette provisions two types of roles:

* [Palette Global Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#paletteglobalresourceroles), the set of roles that are available in Palette console
* [Palette Global Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palette-global-resource-roles), the set of roles that are available in Palette by default.

* [Custom Resource Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palettecustomresourceroles), can be generated according to your requirements from the available set of permissions and operations.
* [Custom Resource Roles](../../..//user-management/palette-rbac/resource-scope-roles-permissions.md#palette-custom-resource-roles), can be generated according to your requirements from the available set of permissions and operations.

### Prerequisites

* A [Palette account](https://console.spectrocloud.com) with Tenant scope privileges.

* A [user created](../../../user-management/new-user.md#createanewuser) to assign the resource privileges.
* A [user created](../../../user-management/new-user.md#create-a-new-user) to assign the resource privileges.

To assign the resource roles and filter to the user follow the below steps:
<br />
Expand Down Expand Up @@ -104,5 +104,5 @@ Upon creating a filter, a display message will pop up to confirm the successful

## Resource

* [Create a New User](../../..//user-management/new-user.md#createanewuser)
* [Create a New User](../../..//user-management/new-user.md#create-a-new-user)

Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Example: `https://metrics.example.com:9090/api/v1/write`
- url: "https://metrics.example.com:9090/api/v1/write"
```

8. Add the `basic_auth` parameters shown below. Replace `<USERNAME>` and `<PASSWORD>` with the actual credential values. Use the username you created to authenticate with the Prometheus API server. If you followed the [Deploy a Monitoring Stack](deploy-monitor-stack.md#deployamonitoringstack) with authentication guide, then the username is `agent`.
8. Add the `basic_auth` parameters shown below. Replace `<USERNAME>` and `<PASSWORD>` with the actual credential values. Use the username you created to authenticate with the Prometheus API server. If you followed the [Deploy a Monitoring Stack](deploy-monitor-stack.md#deploy-a-monitoring-stack) with authentication guide, then the username is `agent`.

<br />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ If you are using Palette Virtual Machine (VM) Management, you can find steps on

:::warning

If you are using [OIDC](/clusters/cluster-management/cluster-rbac#userbacwithoidc) with your host cluster, you will need the kubelogin plugin. Refer to the kubelogin GitHub repository [README](https://github.com/int128/kubelogin#setup) for installation guidance.
If you are using [OIDC](./cluster-rbac.md) with your host cluster, you will need the kubelogin plugin. Refer to the kubelogin GitHub repository [README](https://github.com/int128/kubelogin#setup) for installation guidance.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ The cluster status is updated to **Deleting** while cluster resources are being

## Force Delete a Cluster

If a cluster is stuck in the Deletion state for a minimum of 15 minutes it becomes eligible for force deletion. You can force delete a cluster from the tenant and project admin scopes. To force delete a cluster, follow the same steps outlined in [Delete a MAAS Cluster](/clusters/data-center/maas/create-manage-maas-clusters#deleteamaascluster). After 15 minutes, a **Force Delete Cluster** option is available in the **Settings drop-down menu**. The drop-down menu will provide you with an estimated remaining duration before the force deletion becomes available.
If a cluster is stuck in the Deletion state for a minimum of 15 minutes it becomes eligible for force deletion. You can force delete a cluster from the tenant and project admin scopes. To force delete a cluster, follow the same steps outlined in [Delete a MAAS Cluster](./create-manage-maas-clusters.md#delete-a-maas-cluster). After 15 minutes, a **Force Delete Cluster** option is available in the **Settings drop-down menu**. The drop-down menu will provide you with an estimated remaining duration before the force deletion becomes available.

Upgrade a MAAS cluster to enhance the performance and functionality of the cluster. To learn more about managing a MAAS cluster, refer to [Manage Clusters](../../cluster-management/cluster-updates.md).

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/data-center/vmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -709,7 +709,7 @@ Additional properties that are required to be set only for a proxy environment.
4. Choose the desired values for the Datacenter, Compute Cluster, Datastore, Network, Resource pool, and Folder. Optionally, provide one or more SSH Keys and/or NTP server addresses.


5. Choose the IP Allocation Scheme - Static IP or DHCP. If static IP is selected, an option to create an IP pool is enabled. Proceed to create an IP pool by providing an IP range (start and end IP addresses) or a subnet. The IP addresses from this IP Pool will be assigned to the gateway cluster. By default, the IP Pool is available for use by other tenant clusters. This can be prevented by enabling the **Restrict to a single cluster** button. A detailed description of all the fields involved in the creation of an IP pool can be found [here](/clusters?clusterType=vmware_cluster#ipaddressmanagement).
5. Choose the IP Allocation Scheme - Static IP or DHCP. If static IP is selected, an option to create an IP pool is enabled. Proceed to create an IP pool by providing an IP range (start and end IP addresses) or a subnet. The IP addresses from this IP Pool will be assigned to the gateway cluster. By default, the IP Pool is available for use by other tenant clusters. This can be prevented by enabling the **Restrict to a single cluster** button. A detailed description of all the fields involved in the creation of an IP pool can be found [here](#ip-address-management).


6. Click on **Confirm**, to initiate provisioning of the gateway cluster. The status of the cluster on the UI should change to **Provisioning** and eventually **Running**, when the gateway cluster is fully provisioned. This process might take several minutes (typically 8 to 10 mins).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To start building a custom Edge artifact, use the [Build Edge Artifacts](build-i

### Edge Installer ISO

An ISO file that bootstraps the installation process. The ISO image contains the Edge Installer that installs the Palette Edge host agent and metadata to perform the initial installation. The default Edge Installer ISO download URL is in the [Downloads](/spectro-downloads#edgeinstallimages) resource.
An ISO file that bootstraps the installation process. The ISO image contains the Edge Installer that installs the Palette Edge host agent and metadata to perform the initial installation. The default Edge Installer ISO download URL is in the [Downloads](../../../spectro-downloads.md#palette-edge-cli) resource.

<br />

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/public-cloud/aws/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ hide_table_of_contents: false
---


Palette supports integration with [Amazon Web Services](https://aws.amazon.com). You can deploy and manage [Host Clusters](../../../glossary-all.md#hostcluster) in AWS. To get started check out the [Register and Manage AWS Accounts](add-aws-accounts.md).
Palette supports integration with [Amazon Web Services](https://aws.amazon.com). You can deploy and manage [Host Clusters](../../../glossary-all.md#host-cluster) in AWS. To get started check out the [Register and Manage AWS Accounts](add-aws-accounts.md).



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Palette provides an **Enable encryption** option, which is only available during

- IAM user or role has attached policies listed in [Required IAM Policies](required-iam-policies.md).

- A **PaletteControllersEKSPolicy** created in AWS and attached to the IAM user or role that Palette is using. To create this policy, refer to [Controllers EKS Policy](required-iam-policies.md#controllers-eks-policy).
- A **PaletteControllersEKSPolicy** created in AWS and attached to the IAM user or role that Palette is using. To create this policy, refer to [Controllers EKS Policy](required-iam-policies.md).

- An AWS KMS key created in the AWS region you intend to deploy cluster to with Palette.

Expand Down
7 changes: 5 additions & 2 deletions docs/docs-content/clusters/public-cloud/azure/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
- azure
---

Palette supports integration with [Microsoft Azure](https://azure.microsoft.com/en-us). You can deploy and manage [Host Clusters](../../../glossary-all.md#hostcluster) in Azure. To get started check out the [Register and Manage Azure Cloud Account](azure-cloud.md#manage-azure-accounts).
Palette supports integration with [Microsoft Azure](https://azure.microsoft.com/en-us). You can deploy and manage [Host Clusters](../../../glossary-all.md#host-cluster) in Azure or Azure Government. To get started check out the [Register and Manage Azure Cloud Account](azure-cloud.md).



Expand All @@ -23,7 +23,10 @@ To learn more about Palette and Azure cluster creation and its capabilities chec
- [Register and Manage Azure Cloud Account](azure-cloud.md)


- [Create and Manage Azure Cluster](create-azure-cluster.md#deploy-an-azure-cluster-with-palette)
- [Create and Manage IaaS Azure Cluster](create-azure-cluster.md)


- [Create and Manage Azure AKS Cluster](aks.md)


- [Deleting an Azure Cluster](../../cluster-management/remove-clusters.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Use the following steps to deploy an Azure cluster.

:::warning

If the Azure account is registered with **Disable Properties** and **Static Placement** options enabled, then Palette will not import the network information from your Azure account. You can manually input the information for the **Control Plane Subnet** and the **Worker Network**, but be aware that **drop-down Menu** selections will be empty. To learn more about these settings and certain requirements to use them, refer to [Disable Properties](azure-cloud.md#disable-properties).
If the Azure account is registered with **Disable Properties** and **Static Placement** options enabled, then Palette will not import the network information from your Azure account. You can manually input the information for the **Control Plane Subnet** and the **Worker Network**, but be aware that **drop-down Menu** selections will be empty. To learn more about these settings and certain requirements to use them, refer to [Disable Properties](azure-cloud.md#disable-palette-network-calls-to-azure-account).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1243,7 +1243,7 @@ In this tutorial, you created a cluster profile, which is a template that contai

Palette assures consistency across cluster deployments through cluster profiles. Palette also enables you to quickly deploy applications to a Kubernetes environment with little or no prior Kubernetes knowledge. In a matter of minutes, you were able to provision a new Kubernetes cluster and deploy an application.

We encourage you to check out the [Deploy an Application using Palette Dev Engine](/devx/apps/deploy-app) tutorial to learn more about Palette. Palette Dev Engine can help you deploy applications more quickly through the usage of [virtual clusters](/glossary-all#palettevirtualcluster). Feel free to check out the reference links below to learn more about Palette.
We encourage you to check out the [Deploy an Application using Palette Dev Engine](/devx/apps/deploy-app) tutorial to learn more about Palette. Palette Dev Engine can help you deploy applications more quickly through the usage of [virtual clusters](../../glossary-all.md#palette-virtual-cluster). Feel free to check out the reference links below to learn more about Palette.

<br />

Expand Down
44 changes: 0 additions & 44 deletions docs/docs-content/compliance.md

This file was deleted.

3 changes: 1 addition & 2 deletions docs/docs-content/devx/devx.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,10 @@ The PDE dashboard provides a snapshot of resource utilization in your PDE enviro

## Automation Support

You can manage PDE resources through the [Palette API](/api/introduction), [Spectro Cloud Terraform provider](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs), and the Palette CLI. Download the Palette CLI from the [Downloads](/spectro-downloads#palettecli) page to start programmatically using PDE.
You can manage PDE resources through the [Palette API](/api/introduction), [Spectro Cloud Terraform provider](https://registry.terraform.io/providers/spectrocloud/spectrocloud/latest/docs), and the Palette CLI. Download the Palette CLI from the [Downloads](../spectro-downloads.md#palette-cli) page to start programmatically using PDE.

![A view of the Palette CLI menu from a terminal](/devx_devx_cli-display.png)

Check out the [Palette CLI](/palette-cli/install-palette-cli) for installation guidance.

Check out the Palette CLI [install guide](../palette-cli/install-palette-cli.md) for more information on how to install and configure the CLI.
:::
Expand Down
Loading

0 comments on commit 890720f

Please sign in to comment.