Skip to content

Commit e36fa9f

Browse files
docs: Cluster Templates - Tech Preview Exit (#8957)
* Removing tech preview from cluster templates; adding to release notes * Update README.md * Updating image w/o TP banner * Optimised images with calibre/image-actions --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent c2eabb3 commit e36fa9f

File tree

11 files changed

+55
-39
lines changed

11 files changed

+55
-39
lines changed

README.md

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,16 @@ Result
511511
512512
### Admonitions - Warning / Info / Tip / Danger / Tech Preview / Further Guidance
513513
514+
For guidance on using admonitions in our docs, refer to
515+
[Spectro Cloud Internal Style Guide: Admonitions/Callouts](https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Admonitions%2FCallouts).
516+
517+
To learn more about admonitions in Docusaurus, refer to the
518+
[Admonitions](https://docusaurus.io/docs/markdown-features/admonitions) guide.
519+
520+
The content must have a new line at the beginning and at the end of the tag.
521+
522+
#### Warning
523+
514524
```mdx
515525
:::warning
516526
@@ -519,6 +529,8 @@ Some **content** with _Markdown_ `syntax`.
519529
:::
520530
```
521531
532+
#### Info
533+
522534
```mdx
523535
:::info
524536
@@ -527,6 +539,8 @@ Some **content** with _Markdown_ `syntax`.
527539
:::
528540
```
529541
542+
#### Tip
543+
530544
```mdx
531545
:::tip
532546
@@ -535,6 +549,8 @@ Some **content** with _Markdown_ `syntax`.
535549
:::
536550
```
537551
552+
#### Danger
553+
538554
```mdx
539555
:::danger
540556
@@ -543,6 +559,15 @@ Some **content** with _Markdown_ `syntax`.
543559
:::
544560
```
545561
562+
#### Tech Preview
563+
564+
The `:::preview` admonition is a custom admonition configured in `docusaurus.config.js` under `admonitions.keywords`.
565+
566+
Unlike other admonition types, you do not need to enter content in the admonition block. By default, the Tech Preview
567+
admonition generates the message, "This is a Tech Preview feature and is subject to change. Do not use this feature in
568+
production workloads." This message is hardcoded using `src/theme/Admonition/Type/TechPreview.js`. However, if you need
569+
to deviate from the template text, you can provide a custom message.
570+
546571
```mdx
547572
:::preview
548573
@@ -551,6 +576,22 @@ Some **content** with _Markdown_ `syntax`.
551576
:::
552577
```
553578
579+
Files in `docs/docs-content` and `docs/api-content` are processed during the build phase. However, partials in the
580+
`_partials` directory are dynamically imported at runtime. Because of this, custom admonitions defined in
581+
`docusaurus.config.js` that are used in partials are not rendered, and the custom admonition is ignored.
582+
583+
As a workaround, when using custom admonitions in partials, import and reference the admonition with JSX syntax.
584+
585+
```mdx
586+
import AdmonitionTypeTechPreview from '@theme/Admonition/Type/TechPreview'; # Import below front matter
587+
588+
<AdmonitionTypeTechPreview /> # Use instead of :::
589+
```
590+
591+
Note that when used in partials, the default message cannot be overridden.
592+
593+
#### Further Guidance
594+
554595
```mdx
555596
:::further
556597
@@ -559,12 +600,14 @@ Some **content** with _Markdown_ `syntax`.
559600
:::
560601
```
561602
562-
https://docusaurus.io/docs/markdown-features/admonitions
603+
Like Tech Preview, the Further Guidance admonition is a custom admonition. To use this admonition in partials, you must
604+
import and reference it with JSX syntax.
563605
564-
The content must have a new line at the beginning and at the end of the tag.
606+
```mdx
607+
import AdmonitionTypeFurtherGuidance from '@theme/Admonition/Type/FurtherGuidance'; # Import below front matter
565608
566-
For guidance on using admonitions, refer to
567-
[Spectro Cloud Internal Style Guide: Admonitions/Callouts](https://spectrocloud.atlassian.net/wiki/spaces/DE/pages/1765933057/Spectro+Cloud+Internal+Style+Guide#Admonitions%2FCallouts).
609+
<AdmonitionTypeFurtherGuidance /> # Use instead of :::
610+
```
568611
569612
### Video
570613

_partials/cluster-templates/_profile-vs-template.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,9 @@ partial_category: cluster-templates
33
partial_name: profile-vs-template
44
---
55

6-
import AdmonitionTypeTechPreview from '@theme/Admonition/Type/TechPreview';
7-
86
Choose between deploying your cluster using individual <VersionedLink text="cluster profiles" url="/profiles/cluster-profiles/" />
97
or a single <VersionedLink text="cluster template" url="/cluster-templates" />.
108

11-
:::info
12-
13-
<VersionedLink text="Cluster templates" url="/cluster-templates" /> are a Tech Preview feature and can be used only if the **ClusterTemplates** <VersionedLink text="feature flag" url="/enterprise-version/system-management/feature-flags/" /> is enabled.
14-
15-
:::
16-
179
<Tabs>
1810

1911
<TabItem value="profiles" label="Cluster Profiles">
@@ -36,8 +28,6 @@ or a single <VersionedLink text="cluster template" url="/cluster-templates" />.
3628

3729
<TabItem value="template" label="Cluster Templates">
3830

39-
<AdmonitionTypeTechPreview />
40-
4131
1. On the **Cluster setup type** window, choose **Cluster Template > Select Cluster Template**.
4232

4333
2. Select the appropriate cluster template and **Confirm** your selection.

_partials/self-hosted/feature-flags/_feature-flags-intro.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ The following table lists all available feature flags and their supported platfo
1717
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------: | :------------------------: |
1818
| **AwsSecretPartition** | Configure [AWS Secret Cloud](https://aws.amazon.com/federal/secret-cloud/) accounts and deploy EKS clusters in AWS Secret cloud. Refer to our <VersionedLink text="Register and Manage AWS Accounts" url="/clusters/public-cloud/aws/add-aws-accounts#aws-secret-cloud-account-us" /> guide for more information. | :x: | :white_check_mark: |
1919
| **AzureUSSecretCloud** | Configure [Azure Government Secret](https://azure.microsoft.com/en-us/explore/global-infrastructure/government/national-security) cloud accounts and deploy Azure IaaS clusters in Azure Government Secret cloud. | :x: | :white_check_mark: |
20-
| **ClusterTemplate** | Create reusable blueprints that reference <VersionedLink text="cluster profiles" url="/profiles/cluster-profiles/" /> and <VersionedLink text="policies" url="/cluster-templates/create-cluster-template-policies/" />, allowing you to declaratively define and manage the software and governance stack for a fleet of clusters. Refer to our <VersionedLink text="Cluster Templates" url="/cluster-templates/" /> guide for more information. | :white_check_mark: | :white_check_mark: |
2120
| **LxdMaas** | Spawn multiple control plane nodes as LXD VMs and consolidate them on MAAS-managed servers while your worker nodes run on bare metal devices. Refer to our <VersionedLink text="Create and Manage MAAS Clusters Using LXD VMs" url="/clusters/data-center/maas/create-manage-maas-lxd-clusters/" /> guide for more information. | :white_check_mark: | :white_check_mark: |
2221

2322
:::warning

docs/docs-content/cluster-templates/cluster-templates.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ sidebar_custom_props:
1010
tags: ["cluster templates", "templates", "policies"]
1111
---
1212

13-
:::preview
14-
15-
:::
16-
1713
Cluster templates are reusable blueprints that define and enforce the desired state and lifecycle of clusters deployed
1814
with Palette or [Palette VerteX](../vertex/vertex.md).
1915

docs/docs-content/cluster-templates/create-cluster-template-policies/create-cluster-template-policies.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ sidebar_position: 0
77
tags: ["cluster templates", "policies"]
88
---
99

10-
:::preview
11-
12-
:::
13-
1410
Policies are an integral part of cluster templates. While cluster profiles define the infrastructure and software stack
1511
for your clusters, cluster template policies are modular, reusable definitions that define how the cluster operates as
1612
well as its lifecycle. Policies are linked rather than embedded within cluster templates, allowing you to manage

docs/docs-content/cluster-templates/create-cluster-template-policies/maintenance-policy.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ sidebar_position: 10
77
tags: ["cluster templates", "policies"]
88
---
99

10-
:::preview
11-
12-
:::
13-
1410
A maintenance policy is a required component for [cluster templates](../cluster-templates.md). Maintenance policies
1511
determine when and how upgrades are executed on the cluster. Since clusters can be provisioned across multiple regions
1612
and time zones, upgrades are executed based on Coordinated Universal Time (UTC).

docs/docs-content/cluster-templates/create-cluster-templates.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ sidebar_position: 10
77
tags: ["cluster templates"]
88
---
99

10-
:::preview
11-
12-
:::
13-
1410
[Cluster templates](./cluster-templates.md) allow you to define and enforce the software and governance stack for a
1511
fleet of clusters. By referencing [cluster profiles](../profiles/cluster-profiles/cluster-profiles.md) and operational
1612
[policies](./create-cluster-template-policies/create-cluster-template-policies.md), all while leveraging

docs/docs-content/cluster-templates/delete-cluster-templates.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ sidebar_position: 30
77
tags: ["cluster templates"]
88
---
99

10-
:::preview
11-
12-
:::
13-
1410
To delete a cluster template that is attached to a cluster, you must first delete the cluster and then delete the
1511
template previously attached to the cluster. You cannot delete a cluster template that is linked to a cluster.
1612

docs/docs-content/cluster-templates/modify-cluster-templates.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ toc_max_heading_level: 5
99
tags: ["cluster templates"]
1010
---
1111

12-
:::preview
13-
14-
:::
15-
1612
[Cluster templates](./cluster-templates.md) use [cluster profiles](../profiles/cluster-profiles/cluster-profiles.md) and
1713
cluster [template policies](./create-cluster-template-policies/create-cluster-template-policies.md) to declaratively
1814
define and manage the software stack and lifecycle of clusters deployed with Palette. Since cluster templates are

docs/docs-content/release-notes/release-notes.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ tags: ["release-notes"]
4040

4141
#### Features
4242

43+
- [Cluster templates](../cluster-templates/cluster-templates.md) provide a new way to enforce consistent configurations
44+
and prevent drift across multiple clusters. With cluster templates, you define and enforce the desired state and
45+
lifecycle of clusters by combining [cluster profiles](../profiles/cluster-profiles/cluster-profiles.md) with
46+
operational [policies](../cluster-templates/create-cluster-template-policies/create-cluster-template-policies.md) into
47+
a single, reusable governance blueprint, allowing you to deploy, manage, and upgrade a synchronized fleet of clusters
48+
with minimal effort. Refer to our [Cluster Templates](../cluster-templates/cluster-templates.md) guide for more
49+
information.
50+
4351
#### Improvements
4452

4553
#### Deprecations and Removals

0 commit comments

Comments
 (0)