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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | 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 193x 193x 193x | import dedent from 'dedent';
import _ from 'lodash';
import {
getOtoroshiConfig,
ngDisableOperator,
ngEnableOperator,
rebootOperator,
rebuildOperator,
versionCheck,
versionUpdate,
} from '../clever-client/operators.js';
import { config } from '../config/config.js';
import { Logger } from '../logger.js';
import { findAddonsByAddonProvider } from '../models/ids-resolver.js';
import * as Operator from '../models/operator.js';
import { sendToApi } from '../models/send-to-api.js';
import { openBrowser } from '../models/utils.js';
import { printItemsByOwner } from './print-items-by-owner.js';
import { confirm, selectAnswer } from './prompts.js';
import { styleText } from './style-text.js';
/**
* Check the version of an operator
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @param {string} params.options.format The output format
* @returns {Promise<void>}
*/
export async function operatorCheckVersion(provider, addonIdOrName, format) {
const realId = await Operator.getSingleRealId(addonIdOrName);
const name = getDisplayName(addonIdOrName);
const versions = await versionCheck({ provider, realId }).then(sendToApi);
switch (format) {
case 'json':
Logger.printJson(versions);
break;
case 'human':
default:
if (!versions.needUpdate || (provider === 'metabase' && versions.installed === 'community-latest')) {
Logger.printSuccess(`${styleText('green', name)} is up-to-date (${styleText('green', versions.installed)})`);
} else {
Logger.println(dedent`
🔄 ${styleText('red', name)} is outdated
• Installed version: ${styleText('red', versions.installed)}
• Latest version: ${styleText('green', versions.latest)}
`);
Logger.println();
await confirm(
`Do you want to update it to ${styleText('green', versions.latest)} now?`,
'No confirmation, aborting version update',
);
await versionUpdate({ provider, realId }, { targetVersion: versions.latest }).then(sendToApi);
Logger.printSuccess(`${styleText('green', name)} is up-to-date and being rebuilt…`);
}
break;
}
}
/**
* Update the version of an operator
* @param {string} provider The operator's provider
* @param {string} askedVersion The version to update to
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
*/
export async function operatorUpdateVersion(provider, askedVersion, addonIdOrName) {
const realId = await Operator.getSingleRealId(addonIdOrName);
const name = getDisplayName(addonIdOrName);
const versions = await versionCheck({ provider, realId }).then(sendToApi);
const targetVersion =
askedVersion ??
(await selectAnswer(
`Which version do you want to update ${styleText('blue', name)} to, current is ${styleText('blue', versions.installed)}?`,
versions.available.reverse(),
'Use --target <version> to update directly.',
));
if (!versions.available.includes(targetVersion)) {
throw new Error(`Version ${styleText('red', targetVersion)} is not available`);
}
if (versions.installed === targetVersion) {
Logger.printSuccess(`${styleText('green', name)} is already at version ${styleText('green', targetVersion)}`);
return;
}
await versionUpdate({ provider, realId }, { targetVersion }).then(sendToApi);
Logger.printSuccess(`${styleText('green', name)} updated to ${styleText('green', targetVersion)} and being rebuilt…`);
}
/**
* Unlink an operator from a Network Group
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
* @throws {Error} If the Network Group feature is already disabled
*/
export async function operatorNgDisable(provider, addonIdOrName) {
const name = getDisplayName(addonIdOrName);
const operator = await Operator.getDetails(provider, addonIdOrName);
if (!operator.features.networkGroup?.id) {
throw new Error(`Network Group is already disabled on ${styleText('red', name)}`);
}
await ngDisableOperator({ provider, realId: operator.resourceId }).then(sendToApi);
Logger.println(`Disabling Network Group on ${styleText('blue', name)}…`);
await operatorPrint(provider, addonIdOrName);
}
/**
* Link an operator to a Network Group
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
* @throws {Error} If the Network Group feature is already enabled
*/
export async function operatorNgEnable(provider, addonIdOrName) {
const name = getDisplayName(addonIdOrName);
const operator = await Operator.getDetails(provider, addonIdOrName);
if (operator.features.networkGroup?.id) {
throw new Error(`Network Group is already enabled on ${styleText('red', name)}`);
}
await ngEnableOperator({ provider, realId: operator.resourceId }).then(sendToApi);
Logger.println(`Enabling Network Group on ${styleText('blue', name)}…`);
await operatorPrint(provider, addonIdOrName);
}
/**
* List all operators for a given provider
* @param {string} provider The operator's provider
* @param {string} format The output format
* @returns {Promise<void>}
*/
export async function operatorList(provider, format) {
const deployed = await findAddonsByAddonProvider(provider);
const providerName = _.capitalize(provider.replace('addon-', ''));
switch (format) {
case 'json': {
const operatorsPerOwner = Object.groupBy(deployed, (o) => o.ownerId);
Logger.printJson(operatorsPerOwner);
break;
}
case 'human':
default:
printItemsByOwner(deployed, {
itemName: `${providerName} operator`,
emptyCommand: `clever addon create ${providerName.toLocaleLowerCase()}`,
getItemId: (o) => o.realId,
});
break;
}
}
/**
* Open an operator dashboard in the Clever Cloud Console in the browser
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
*/
export async function operatorOpen(provider, addonIdOrName) {
const operator = await Operator.getDetails(provider, addonIdOrName);
await openBrowser(
`${config.GOTO_URL}/${operator.addonId}`,
`Opening ${styleText('blue', operator.addonId)} in the browser…`,
);
}
/**
* Open the Logs section of an operator application in the Clever Cloud Console
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
*/
export async function operatorOpenLogs(provider, addonIdOrName) {
const operator = await Operator.getDetails(provider, addonIdOrName);
await openBrowser(
`/organisations/${operator.ownerId}/applications/${operator.resources.entrypoint}/logs`,
`Opening ${styleText('blue', operator.addonId)} logs in the browser…`,
);
}
/**
* Open an operator Web UI in the browser
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
*/
export async function operatorOpenWebUi(provider, addonIdOrName) {
const operator = await Operator.getDetails(provider, addonIdOrName);
await openBrowser(operator.accessUrl, `Opening ${styleText('blue', operator.addonId)} web UI in the browser…`);
}
/**
* Open an Otoroshi Swagger UI in the browser
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
*/
export async function operatorOpenSwaggerUi(addonIdOrName) {
const operator = await Operator.getDetails('otoroshi', addonIdOrName);
await openBrowser(
operator.api.swaggerUrl,
`Opening ${styleText('blue', operator.addonId)} Swagger UI in the browser…`,
);
}
/**
* Reboot an operator
* @param {object} params The command's parameters
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
*/
export async function operatorReboot(provider, addonIdOrName) {
const name = getDisplayName(addonIdOrName);
const realId = await Operator.getSingleRealId(addonIdOrName);
await rebootOperator({ provider, realId }).then(sendToApi);
Logger.println(`🔄 Restarting ${styleText('blue', name)}…`);
}
/**
* Rebuild an operator
* @param {object} params The command's parameters
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @returns {Promise<void>}
*/
export async function operatorRebuild(provider, addonIdOrName) {
const name = getDisplayName(addonIdOrName);
const realId = await Operator.getSingleRealId(addonIdOrName);
await rebuildOperator({ provider, realId }).then(sendToApi);
Logger.println(`🔄 Rebuilding ${styleText('blue', name)}…`);
}
/**
* Print the details of an operator
* @param {string} provider The operator's provider
* @param {{ addon_name?: string, operator_id?: string, addon_id?: string }} addonIdOrName The operator's name or ID
* @param {string} format The output format
* @returns {void}
*/
export async function operatorPrint(provider, addonIdOrName, format = 'human') {
const operator = await Operator.getDetails(provider, addonIdOrName);
if (provider === 'otoroshi' && format === 'otoroshictl') {
const otoroshiConfig = await getOtoroshiConfig({ realId: operator.resourceId }).then(sendToApi);
Logger.println(otoroshiConfig);
return;
}
const dataToPrint = {
Name: operator.name,
ID: operator.resourceId,
Owner: operator.ownerId,
};
dataToPrint.Version =
provider === 'matomo'
? `${operator.version} (PHP ${operator.phpVersion})`
: `${operator.version} (Java ${operator.javaVersion})`;
dataToPrint['Access URL'] = operator.accessUrl;
if (provider === 'otoroshi') {
dataToPrint['Swagger URL'] = operator.api.swaggerUrl;
dataToPrint['API endpoint'] = operator.api.url;
}
if (['otoroshi', 'keycloak'].includes(provider)) {
dataToPrint['Network Group'] = operator.features.networkGroup?.id ?? false;
}
switch (format) {
case 'json':
Logger.printJson(operator);
break;
case 'human':
default:
console.table(dataToPrint);
break;
}
}
function getDisplayName(addonIdOrName) {
return addonIdOrName.addon_name ?? addonIdOrName.operator_id ?? addonIdOrName.addon_id;
}
|