Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 196x 196x 196x 196x 12x 12x 12x 196x 184x 184x 184x 196x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 193x 10x 10x 10x | import dedent from 'dedent';
import z from 'zod';
import { readJson, writeJson } from '../lib/fs.js';
import { Logger } from '../logger.js';
import { config } from './config.js';
export const EXPERIMENTAL_FEATURES = {
'system-git': {
status: 'beta',
description: 'Use system git instead of current JS implementation for git operations',
instructions: dedent`
This feature switches from the current JS implementation to using
the git installed on your system.
Requirements:
- git must be installed and available in your PATH
`,
},
k8s: {
status: 'beta',
description: 'Deploy and manage Kubernetes clusters on Clever Cloud',
instructions: dedent`
- Create a Kubernetes cluster:
clever k8s create my-cluster
clever k8s create my-cluster --org myOrg
- List Kubernetes clusters:
clever k8s list
- Get details about a Kubernetes cluster:
clever k8s get my-cluster
- Get kubeconfig file for a Kubernetes cluster:
clever k8s get-kubeconfig my-cluster
clever k8s get-kubeconfig my-cluster > ~/.kube/config
- Activate persistent storage on a Kubernetes cluster:
clever k8s add-persistent-storage my-cluster
- Delete a Kubernetes cluster:
clever k8s delete my-cluster
Learn more about Clever Kubernetes: ${config.DOC_URL}/kubernetes/
`,
},
kv: {
status: 'beta',
description:
'Send commands to databases such as Materia KV or Redis® directly from Clever Tools, without other dependencies',
instructions: dedent`
Target any compatible add-on by its name or ID (with an org ID if needed) and send commands to it:
clever kv myMateriaKV SET myKey myValue
clever kv kv_xxxxxxxx GET myKey -F json
clever kv addon_xxxxx SET myTempKey myTempValue EX 120
clever kv myMateriaKV -o myOrg TTL myTempKey
clever kv redis_xxxxx --org org_xxxxx PING
Learn more about Materia KV: ${config.DOC_URL}/addons/materia-kv/
`,
},
ng: {
status: 'beta',
description: 'Manage Network Groups to manage applications, add-ons, external peers through a WireGuard network',
instructions: dedent`
- Create a Network Group:
clever ng create myNG
- Create a Network Group with members (application, database add-on):
clever ng create myNG --link app_xxx,postgresql_xxx
- List Network Groups:
clever ng
- Delete a Network Group:
clever ng delete myNG
- (Un)Link an application or a database add-on to an existing Network Group:
clever ng link app_xxx myNG
clever ng unlink postgresql_xxx myNG
- Get the WireGuard configuration of a peer:
clever ng get-config peerIdOrLabel myNG
- Get details about a Network Group, a member or a peer:
clever ng get myNg
clever ng get app_xxx
clever ng get peerId
clever ng get memberLabel
- Search Network Groups, members or peers:
clever ng search myQuery
Learn more about Network Groups: ${config.DOC_URL}/develop/network-groups/
`,
},
operators: {
status: 'beta',
description: 'Manage operators and their features such as Keycloak, Matomo, Metabase, Otoroshi',
instructions: dedent`
clever keycloak
clever keycloak get keycloak_xxx
clever keycloak ng enable myKeycloak
clever metabase version check myMetabase
clever metabase version update myMetabase 0.53
clever matomo open myMatomo
clever otoroshi open logs myOtoroshi
`,
},
};
const FeaturesConfigSchema = z
.object(Object.fromEntries(Object.keys(EXPERIMENTAL_FEATURES).map((key) => [key, z.boolean()])))
.partial();
/**
* @typedef {z.infer<typeof FeaturesConfigSchema>} FeaturesConfig
*/
/**
* Gets the current experimental features configuration.
* Returns an empty object if the features file doesn't exist or is invalid.
* @returns {Promise<FeaturesConfig>} The features configuration object
*/
export async function getFeatures() {
const filePath = config.EXPERIMENTAL_FEATURES_FILE;
Logger.debug(`Get features configuration from ${filePath}`);
try {
const rawFeatures = await readJson(filePath);
const parsed = FeaturesConfigSchema.safeParse(rawFeatures);
if (!parsed.success) {
Logger.info(`Invalid features format in ${filePath}`);
return {};
}
return parsed.data;
} catch (error) {
if (error.code !== 'ENOENT') {
throw new Error(`Cannot get experimental features configuration from ${filePath}`);
}
return {};
}
}
/**
* Sets an experimental feature to the specified value.
* Creates the configuration directory and features file if they don't exist.
* @param {string} feature - The name of the feature to set
* @param {boolean} value - The value to set for the feature
* @returns {Promise<void>}
* @throws {Error} If the features file cannot be written
*/
export async function setFeature(feature, value) {
const filePath = config.EXPERIMENTAL_FEATURES_FILE;
const currentFeatures = await getFeatures();
const newFeatures = { ...currentFeatures, [feature]: value };
try {
await writeJson(filePath, newFeatures, { mode: 0o700 });
} catch (error) {
throw new Error(`Cannot write experimental features configuration to ${filePath}`);
}
}
/**
* Checks if an experimental feature is enabled.
* @param {string} feature - The name of the feature to check
* @returns {Promise<boolean>} True if the feature is explicitly enabled, false otherwise
*/
export async function isFeatureEnabled(feature) {
const features = await getFeatures();
return features[feature] === true;
}
|