-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: PEM-5064 * draft * docs: test * docs: added draft * chore: fix broken page issue * docs: added warning * Apply suggestions from code review Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * chore: fix prettier * chore: fixed partials --------- Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
- Loading branch information
1 parent
6d0c73d
commit 8aa711b
Showing
6 changed files
with
150 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
partial_category: feature-flags | ||
partial_name: feature-flags-overview | ||
--- | ||
|
||
<!-- prettier-ignore --> | ||
Feature flags allow <PaletteURL text="system administrators" edition={props.edition} url="/system-management/account-management/#system-administrators" /> to | ||
manage what features are available to the system's tenants. They can use this capability to roll out new features to {props.edition} tenants in a controlled manner or choose not to implement a feature for their tenants due to security or compliance reasons. | ||
|
||
Features enabled by system administrators are applied to all tenants in the system. Once a feature is enabled, it cannot | ||
be disabled. | ||
|
||
:::warning | ||
|
||
We recommend trying out new features in a test environment before enabling them in a production environment. Depending | ||
on the feature, enabling it may have a significant impact on the system and current workloads. | ||
|
||
::: | ||
|
||
Review the following section for detailed instructions on enabling and managing feature flags. | ||
|
||
## Enable a Feature | ||
|
||
Use the following steps to enable a feature flag. | ||
|
||
## Prerequisites | ||
|
||
- You are a system administrator of the type _Operations Administrator_ or _Root Administrator_. | ||
|
||
- You have access to the system console. | ||
|
||
## Enablement | ||
|
||
<!-- prettier-ignore --> | ||
1. Log in to the system console. For additional guidance on accessing the system console, check out the | ||
<PaletteURL | ||
edition={props.edition} | ||
text="Access the System Console" | ||
url="/system-management/#access-the-system-console" | ||
/> guide. | ||
|
||
2. From the left **Main Menu**, select **Administration**. | ||
|
||
3. Select the **Feature Flags** tab. | ||
|
||
4. Locate the feature you want to enable and toggle the switch on the right to enable it. You can also search | ||
for a feature by typing the feature name in the search bar. | ||
|
||
## Validate | ||
|
||
Use the following steps to validate that the feature flag is enabled. | ||
|
||
1. Log in as a tenant administrator to one of the tenants in the system. | ||
|
||
2. Attempt to access the enabled feature flag. If the feature is enabled, you will be able to use it. If the feature is | ||
disabled, you will not be able to access it. | ||
|
||
export function PaletteURL({ edition, text, url }) { | ||
return ( | ||
<> | ||
{edition.toLowerCase() === "palette" ? ( | ||
<VersionedLink text={text} url={`/enterprise-version${url}`} /> | ||
) : ( | ||
<VersionedLink text={text} url={`/vertex${url}`} /> | ||
)} | ||
</> | ||
); | ||
} |
14 changes: 14 additions & 0 deletions
14
docs/docs-content/enterprise-version/system-management/feature-flags.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
sidebar_label: "Feature Flags" | ||
title: "Feature Flags" | ||
description: "Learn how to to use feature flags to manage features in Palette" | ||
icon: "" | ||
hide_table_of_contents: false | ||
sidebar_position: 60 | ||
tags: ["self-hosted", "management", "feature-flags"] | ||
keywords: ["self-hosted", "palette", "feature-flags"] | ||
--- | ||
|
||
import FeatureFlagsPartial from "../../../../_partials/feature_flags/_feature_flags_overview.mdx"; | ||
|
||
<FeatureFlagsPartial name="feature-flags-overview" edition="Palette" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 14 additions & 0 deletions
14
docs/docs-content/vertex/system-management/feature-flags.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
sidebar_label: "Feature Flags" | ||
title: "Feature Flags" | ||
description: "Learn how to to use feature flags to manage features in Palette VerteX" | ||
icon: "" | ||
hide_table_of_contents: false | ||
sidebar_position: 60 | ||
tags: ["vertex", "management", "feature-flags"] | ||
keywords: ["self-hosted", "vertex", "feature-flags"] | ||
--- | ||
|
||
import FeatureFlagsPartial from "../../../../_partials/feature_flags/_feature_flags_overview.mdx"; | ||
|
||
<FeatureFlagsPartial name="feature-flags-overview" edition="VerteX" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1,51 @@ | ||
import { faCubes } from '@fortawesome/free-solid-svg-icons'; | ||
import { faTerminal } from '@fortawesome/free-solid-svg-icons'; | ||
import { faPersonWalkingLuggage } from '@fortawesome/free-solid-svg-icons'; | ||
import { faObjectGroup } from '@fortawesome/free-solid-svg-icons'; | ||
import { faEnvelopeOpenText } from '@fortawesome/free-solid-svg-icons'; | ||
import { faDatabase } from '@fortawesome/free-solid-svg-icons'; | ||
import { faHdd } from '@fortawesome/free-solid-svg-icons'; | ||
import { faCloudArrowDown } from '@fortawesome/free-solid-svg-icons'; | ||
import { faNetworkWired } from '@fortawesome/free-solid-svg-icons'; | ||
import { faServer } from '@fortawesome/free-solid-svg-icons'; | ||
import { faUsers } from '@fortawesome/free-solid-svg-icons'; | ||
import { faWarehouse } from '@fortawesome/free-solid-svg-icons'; | ||
import { faFlagCheckered } from '@fortawesome/free-solid-svg-icons'; | ||
import { faPalette } from '@fortawesome/free-solid-svg-icons'; | ||
import { faBook } from '@fortawesome/free-solid-svg-icons'; | ||
import { faBookmark } from '@fortawesome/free-solid-svg-icons'; | ||
import { faGavel } from '@fortawesome/free-solid-svg-icons'; | ||
import { faTowerObservation } from '@fortawesome/free-solid-svg-icons'; | ||
import { faLock } from '@fortawesome/free-solid-svg-icons'; | ||
import { faGears } from '@fortawesome/free-solid-svg-icons'; | ||
import { faScrewdriverWrench } from '@fortawesome/free-solid-svg-icons'; | ||
import { faEyeSlash } from '@fortawesome/free-solid-svg-icons'; | ||
import { faShield } from '@fortawesome/free-solid-svg-icons'; | ||
import { faMicrochip } from '@fortawesome/free-solid-svg-icons'; | ||
|
||
export const fontAwesomeIcons = { | ||
"cubes": faCubes, | ||
"terminal": faTerminal, | ||
"person-walking-luggage": faPersonWalkingLuggage, | ||
"object-group": faObjectGroup, | ||
"envelope-open-text": faEnvelopeOpenText, | ||
"database": faDatabase, | ||
"hdd": faHdd, | ||
"cloud-arrow-down": faCloudArrowDown, | ||
"network-wired": faNetworkWired, | ||
"server": faServer, | ||
"users": faUsers, | ||
"warehouse": faWarehouse, | ||
"flag-checkered": faFlagCheckered, | ||
"palette": faPalette, | ||
"book": faBook, | ||
"bookmark": faBookmark, | ||
"gavel": faGavel, | ||
"tower-observation": faTowerObservation, | ||
"lock": faLock, | ||
"gears": faGears, | ||
"screwdriver-wrench": faScrewdriverWrench, | ||
"eye-slash": faEyeSlash, | ||
"shield": faShield, | ||
"microchip": faMicrochip | ||
import { faCubes } from '@fortawesome/free-solid-svg-icons'; | ||
import { faTerminal } from '@fortawesome/free-solid-svg-icons'; | ||
import { faPersonWalkingLuggage } from '@fortawesome/free-solid-svg-icons'; | ||
import { faObjectGroup } from '@fortawesome/free-solid-svg-icons'; | ||
import { faEnvelopeOpenText } from '@fortawesome/free-solid-svg-icons'; | ||
import { faDatabase } from '@fortawesome/free-solid-svg-icons'; | ||
import { faHdd } from '@fortawesome/free-solid-svg-icons'; | ||
import { faCloudArrowDown } from '@fortawesome/free-solid-svg-icons'; | ||
import { faNetworkWired } from '@fortawesome/free-solid-svg-icons'; | ||
import { faServer } from '@fortawesome/free-solid-svg-icons'; | ||
import { faUsers } from '@fortawesome/free-solid-svg-icons'; | ||
import { faWarehouse } from '@fortawesome/free-solid-svg-icons'; | ||
import { faFlagCheckered } from '@fortawesome/free-solid-svg-icons'; | ||
import { faPalette } from '@fortawesome/free-solid-svg-icons'; | ||
import { faBook } from '@fortawesome/free-solid-svg-icons'; | ||
import { faBookmark } from '@fortawesome/free-solid-svg-icons'; | ||
import { faGavel } from '@fortawesome/free-solid-svg-icons'; | ||
import { faTowerObservation } from '@fortawesome/free-solid-svg-icons'; | ||
import { faLock } from '@fortawesome/free-solid-svg-icons'; | ||
import { faGears } from '@fortawesome/free-solid-svg-icons'; | ||
import { faScrewdriverWrench } from '@fortawesome/free-solid-svg-icons'; | ||
import { faEyeSlash } from '@fortawesome/free-solid-svg-icons'; | ||
import { faShield } from '@fortawesome/free-solid-svg-icons'; | ||
import { faMicrochip } from '@fortawesome/free-solid-svg-icons'; | ||
|
||
export const fontAwesomeIcons = { | ||
"cubes": faCubes, | ||
"terminal": faTerminal, | ||
"person-walking-luggage": faPersonWalkingLuggage, | ||
"object-group": faObjectGroup, | ||
"envelope-open-text": faEnvelopeOpenText, | ||
"database": faDatabase, | ||
"hdd": faHdd, | ||
"cloud-arrow-down": faCloudArrowDown, | ||
"network-wired": faNetworkWired, | ||
"server": faServer, | ||
"users": faUsers, | ||
"warehouse": faWarehouse, | ||
"flag-checkered": faFlagCheckered, | ||
"palette": faPalette, | ||
"book": faBook, | ||
"bookmark": faBookmark, | ||
"gavel": faGavel, | ||
"tower-observation": faTowerObservation, | ||
"lock": faLock, | ||
"gears": faGears, | ||
"screwdriver-wrench": faScrewdriverWrench, | ||
"eye-slash": faEyeSlash, | ||
"shield": faShield, | ||
"microchip": faMicrochip | ||
}; |