Skip to content

Commit

Permalink
Merge branch 'master' into antongisli-patch-2
Browse files Browse the repository at this point in the history
  • Loading branch information
karl-cardenas-coding committed Jun 5, 2023
2 parents a12144b + b15a7f2 commit c7cc1c1
Show file tree
Hide file tree
Showing 19 changed files with 1,382 additions and 32 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ If you plan to deploy host clusters to AWS EKS, make sure to attach the **Palett
"iam:CreateOpenIDConnectProvider",
"iam:DeleteOpenIDConnectProvider",
"iam:ListOpenIDConnectProviders",
"iam:UpdateOpenIDConnectProviderThumbprint",
"iam:UpdateOpenIDConnectProviderThumbprint"
],
"Resource": [
"*"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ Palette supports creating and managing Kubernetes clusters deployed to a MAAS ac

- A cluster profile for the MAAS environment. Review [Cluster Profiles](/cluster-profiles) for more information.


- Verify that the required Operating System (OS) images you use in your cluster profiles are downloaded and available in your MAAS environment. Review the [How to use standard images](https://maas.io/docs/how-to-use-standard-images) for guidance on downloading OS images for MAAS.


# Deploy a MAAS cluster

To deploy a new MAAS cluster:
Expand Down Expand Up @@ -118,18 +122,25 @@ The cluster status is updated to **Deleting** while cluster resources are being

<br />

## 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.
# Upgrade a MAAS Cluster

<br />
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](https://docs.spectrocloud.com/clusters/cluster-management/cluster-updates).

To protect your data, we recommend you create a backup of your MAAS cluster before proceeding with any upgrades or infrastructure changes. Review instructions provided in the [Backup and Restore](https://docs.spectrocloud.com/clusters/cluster-management/backup-restore).

<br />

<WarningBox>

A force delete can result in Palette-provisioned resources being missed during the removal process. Verify that any MAAS machines associated with the cluster have been released. Failure to remove provisioned resources can result in unexpected costs.
Ensure that the Operating System (OS) image selected for your cluster are downloaded and available for your MAAS configuration to eliminate errors in Pallete. You can refer to the [How to use standard images](https://maas.io/docs/how-to-customise-images) guide for instructions on downloading OS images compatible with their respective MAAS environment.



</WarningBox>



# Next Steps

Now that you’ve deployed a MAAS cluster, you can start developing and deploying applications to your cluster. We recommend you review the Day-2 operations and become familiar with the cluster management tasks. Check out the [Manage Clusters](/clusters/cluster-management) documentation to learn more about Day-2 responsibilities.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ The Edge Installer is configured with a set of default values.
| `PaletteEndpoint`| `api.console.spectrocloud.com`| The Palette API endpoint. |
| `Prefix`| `edge`| The default prefix to apply to the unique identifier. |
| `RegistrationURL`| `https://edge-registration-generic.vercel.app`| The URL that operators should use when registering the Edge host with Palette.|
| `installHarbor`| `false`| Set to `true` to enable the usage of a Harbor registry.|

The default values assume you are installing the Edge host in an environment without a network proxy, do not require remote access to the Edge host, and are using Palette SaaS. If you have requirements different from the default values, you must provide the Edge Installer with additional information.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/06-integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ When you create a cluster profile, you choose the type of pack you want to add:

When you choose **Infrastructure** or **Add-on**, Palette presents only packs that provide functionality for the selected pack type. When you choose **Full**, Palette presents all the packs so you can build your cluster profile from the base layer up. To learn more about cluster profiles, check out the [Cluster Profiles](/cluster-profiles) guide.

To learn more about individual packs, use the search bar below to find a specific option. Alternatively, use the filter buttons to display available options.
To learn more about individual packs, use the search bar below to find a specific option. Alternatively, you can use the filter buttons to display available options. To learn about pack update and deprecation schedules, review [Maintenance Policy](/integrations/maintenance-policy).
<Packs />
</Content>
39 changes: 15 additions & 24 deletions content/docs/06-integrations/00-kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Kubernetes"
metaTitle: "Kubernetes in Palette"
metaDescription: "Kubernetes pack that deploys containers in Palette."
title: "Palette eXtended Kubernetes"
metaTitle: "Palette eXtended Kubernetes"
metaDescription: "Learn more about the Palette eXtended Kubernetes pack and how you can use it with your host clusters."
hiddenFromNav: true
type: "integration"
category: ["kubernetes"]
Expand All @@ -14,44 +14,35 @@ import InfoBox from 'shared/components/InfoBox';
import PointsOfInterest from 'shared/components/common/PointOfInterest';
import Tooltip from "shared/components/ui/Tooltip";

# Kubernetes
# Palette eXtended Kubernetes

The Kubernetes pack defines the default properties that we use to deploy Kubernetes clusters. Most of the Kubernetes hardening standards that the Center for Internet Security (CIS) recommends are enabled by default. The Kubernetes pack supports most [cloud and data center infrastructure providers](/clusters).
The [Palette eXtended Kubernetes](/glossary-all#paletteextendedkubernetes(pxk)) (PXK) pack supports several [cloud and data center infrastructure providers](/clusters). This pack defines the default properties we use to deploy Kubernetes clusters and enables most of the Kubernetes hardening standards that the Center for Internet Security (CIS) recommends.

Spectro Cloud offers Cloud Native Computing Foundation (CNCF) Kubernetes as a core infrastructure pack in Palette. We release Kubernetes updates as follows:
We also support managed Kubernetes distributions for Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), Google Kubernetes Engine (GKE), and Tencent Kubernetes Engine (TKE).

<br />

- Major versions are assessed based on the extent of changes.
- Minor versions are provided within eight weeks of a new Kubernetes release.
- Patch versions are provided within four weeks of a new Kubernetes release.

In the period of time following a Kubernetes release, the Kubernetes pack undergoes rigorous vulnerability scans and penetration testing.
We offer PXK as a core pack in Palette.

A minor Kubernetes version will be deprecated in Palette when the Kubernetes community announces the version is entering End of Life (EOL). The deprecated version will remain in that state for three months and will be disabled after a quarter and deleted from Palette in the following quarter.
Review [Maintenance Policy](/integrations/maintenance-policy) to learn about pack update and deprecation schedules.

Below are the stages of deprecation:

<br />
## What is PXK?

- **Deprecate**: When a pack is deprecated, Palette displays a warning. You will still be able to create new cluster profiles using the pack and launch clusters using existing profiles that contain the pack.
Palette eXtended Kubernetes (PXK) is a customized version of the open-source Cloud Native Computing Foundation (CNCF) distribution of Kubernetes. This Kubernetes version can be deployed through Palette to all major infrastructure providers, public cloud providers, and private data center providers. This is the default distribution when deploying a Kubernetes cluster through Palette. You have the option to choose other Kubernetes distributions, such as MicroK8s, Konvoy, and more, should you want to consume a different Kubernetes distribution.

PXK is different from the upstream open-source Kubernetes version primarily because of the carefully reviewed and applied hardening of the operating system (OS) and Kubernetes. The hardening ranges from removing unused kernel modules to using an OS configuration that follows industry best practices. Our custom Kubernetes configuration addresses common Kubernetes deployment security pitfalls and implements industry best practices.

- **Disable**: When a pack is disabled, you will no longer be allowed to create new cluster profiles using the pack. Palette displays a message informing you to cut over to the newer version of the pack. However, you can still deploy new clusters using existing profiles that contain the deprecated pack.
A benefit of Palette when used with PXK is the ability to apply different flavors of container storage interface (CSI) plugins and container network interface (CNI) plugins. Other open-source Kubernetes distributions, such as MicroK8s, RKE2, and K3s, come with a default CSI and CNI. Additional complexity and overhead are required from you to enable different interfaces. PXK supports the ability to select other interface plugins out of the box without any additional overhead or complexity needed from your side.


- **Delete**: When a pack is deleted, you will not be able to create new cluster profiles using the pack or launch new clusters using the existing profiles that contain the pack. Palette displays a message informing you to cut over to the newer version of the pack. There is no disruption to existing cluster workloads and will continue to be functional.
There are no changes to the Kubernetes source code and we also follow the same versioning schema as the upstream open-source Kubernetes distribution.

<br />

<InfoBox>

For important guidelines on updating pack versions, review [Update the Pack Version](/cluster-profiles/task-update-profile#updatethepackversion).
<InfoBox>

We also offer Palette eXtended Kubernetes Edge (PXK-E) for Edge deployments. Refer to the [PXK-E glossary definition](/glossary-all#paletteextendedkubernetesedge(pxk-e)) to learn more about PXK-E.

</InfoBox>


# Versions Supported


Expand Down
177 changes: 177 additions & 0 deletions content/docs/06-integrations/01-maintenance-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
---
title: "Maintenance Policy"
metaTitle: "Packs Maintenance Policy"
metaDescription: "Learn about Palette pack update and deprecation schedules."
icon: ""
hideToC: false
fullWidth: true
hideToCSidebar: false
---

import {Content} from "shared/layouts/Default";
import Tabs from "shared/components/ui/Tabs";
import Packs from "shared/components/common/Integrations/Packs"
import AppTiers from "shared/components/common/Integrations/AppTiers"
import WarningBox from 'shared/components/WarningBox';
import InfoBox from 'shared/components/InfoBox';



# Overview

Palette supports two pack categories: *Core* and *Add-on*. Core packs, which we often source from third parties, are infrastructure related or have prominence in container-based environments. They create the layers in Palette profiles. Core packs are grouped as follows:

- Kubernetes

- Operating System (OS)

- Container Network Interface (CNI)

- Container Storage Interface (CSI)


Add-on packs provide additional functionality that you can add to your cluster profile and are grouped as follows:

- Load Balancer

- Ingress

- Logging

- Monitoring

- Security

- Authenticaiton

- System Apps


Check out the [Packs List](/integrations) document, where you can use the filter buttons to display a list of Palette packs in each category and learn about the individual packs.

<br />

## Pack Updates

Packs undergo rigorous vulnerability scans and penetration testing before they become available in Palette. The following sections describe our update schedule for each core pack category.

<br />

### Kubernetes Packs

We provide Cloud Native Computing Foundation (CNCF) Kubernetes updates as follows:

<br />

- **Major versions**: Assessed based on the extent of changes.


- **Minor versions**: Provided within eight weeks of a new Kubernetes release.


- **Patch versions**: Provided within four weeks of a new Kubernetes release.



### OS Packs

We provide Ubuntu LTS and CentOS updates for IaaS clusters as follows:

<br />

- **Major versions** - Added within 8 weeks of release.


- **Patch and Minor versions**: Updated at runtime using Palette’s on-demand or scheduled OS upgrades and patch-on-boot capabilities.


### CNI Packs

We provide CNI pack updates as follows:

<br />

- **Major versions**: Assessed based on the extent of changes.


- **Minor version**: Added within 6 weeks of release.


- **Patch versions**: Added within 4 weeks of release.


### CSI Packs

We provide CSI pack updates as follows:

<br />

- **Major versions**: Assessed based on the extent of changes.


- **Minor version**: Added within 6 weeks of release.


- **Patch versions**: Added within 4 weeks of release.


### Add-on Packs

We provide add-on pack updates as follows:

<br />

- **Major versions**: Assessed based on the extent of changes.


- **Minor version**: Added within 6 weeks of release.


- **Patch versions**: Added within 4 weeks of release.


## Packs Deprecation


<!-- We deprecate and remove packs when a more stable version of the pack is available or when the underlying technology becomes obsolete. -->

<!-- Below are the stages of deprecation we adhere to. -->

We deprecate and remove packs when a more stable version of the pack is available or when the underlying technology becomes obsolete. We deprecate a pack six months before deleting it. Post deprecation, you will still be able to create new cluster profiles using the pack and deploy clusters that use profiles containing the pack. Our Release Notes announce when a pack is deprecated and a replacement pack is available.


<br />

<!-- - **Deprecated**: When a pack is deprecated, Palette displays a warning. You will still be able to create new cluster profiles using the pack and launch clusters using existing profiles that contain the pack.
The pack remains in *Deprecated* state for three months before it moves to *Disabled* state.
- **Disabled**: When a pack is disabled, you will no longer be allowed to create new cluster profiles using the pack. Palette displays a message informing you to use a newer version of the pack. However, you can still deploy new clusters using existing profiles that contain the pack.
The pack remains in *Disabled* state for three months before it is deleted.
- **Deleted**: When a pack is deleted, you will not be able to create new cluster profiles that use it or launch new clusters with existing profiles that contain the pack. Palette displays a message informing you to use a newer version of the pack. Existing clusters are not disturbed and will continue to be functional.
- **Deleted**: When a pack is deleted, you will not be able to create new cluster profiles that use it or launch new clusters with existing profiles that contain the pack. You must use a newer version of the pack. Existing clusters that use the pack are not disturbed and will continue to be functional. 2 -->

<InfoBox>

For important guidelines on updating pack versions, review [Update the Pack Version](/cluster-profiles/task-update-profile#updatethepackversion).

</InfoBox>

### Kubernetes Packs

A minor Kubernetes version is deprecated in Palette when the Kubernetes community announces the version is entering End of Life (EOL).

<br />

### CNI / CSI / Add-on Packs

Palette supports a minor version of CNI, CSI, and add-on packs until two newer versions are available. At that time, packs in these categories are deprecated.


<br />

<br />

2 changes: 1 addition & 1 deletion content/docs/17-glossary-all.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Palette eXtended Kubernetes (PXK) is a customized version of the open-source Clo
PXK is different from the upstream open-source Kubernetes version primarily because of the carefully reviewed and applied hardening of the operating system (OS) and Kubernetes. The hardening ranges from removing unused kernel modules to using an OS configuration that follows industry best practices. Our custom Kubernetes configuration addresses common Kubernetes deployment security pitfalls and implements industry best practices.

A benefit of Palette when used with PXK is the ability to apply different flavors of container storage interface (CSI) plugins and container network interface (CNI) plugins.
Other open-source Kubernetes distributions, such as MicroK8s, RKE2, and K3s, come with a default CSI and CNI. Additional complexity and overhead are required from you to enable different interface. PXK supports the ability to select other interface plugins out of the box without any additional overhead or complexity needed from your side.
Other open-source Kubernetes distributions, such as MicroK8s, RKE2, and K3s, come with a default CSI and CNI. Additional complexity and overhead are required from you to enable different interfaces. PXK supports the ability to select other interface plugins out of the box without any additional overhead or complexity needed from your side.

There are no changes to the Kubernetes source code and we also follow the same versioning schema as the upstream open-source Kubernetes distribution.

Expand Down
Loading

0 comments on commit c7cc1c1

Please sign in to comment.