feat(cc-addon-*.smart-kubernetes): init #1588
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,191 @@ | ||
| // @ts-expect-error FIXME: remove when clever-client exports types | ||
| import { ONE_SECOND } from '@clevercloud/client/esm/with-cache.js'; | ||
| import { getAssetUrl } from '../../lib/assets-url.js'; | ||
| import { fakeString } from '../../lib/fake-strings.js'; | ||
| import { notify, notifyError } from '../../lib/notifications.js'; | ||
| import { sendToApi } from '../../lib/send-to-api.js'; | ||
| import { defineSmartComponent } from '../../lib/smart/define-smart-component.js'; | ||
| import { i18n } from '../../translations/translation.js'; | ||
| import '../cc-smart-container/cc-smart-container.js'; | ||
| import './cc-addon-header.js'; | ||
|
|
||
| const PROVIDER_ID = 'kubernetes'; | ||
| const FIFTY_MINUTES = 50 * 60 * 1000; | ||
|
|
||
| /** | ||
| * @typedef {import('./cc-addon-header.js').CcAddonHeader} CcAddonHeader | ||
| * @typedef {import('./cc-addon-header.types.js').DeploymentStatus} DeploymentStatus | ||
| * @typedef {import('./cc-addon-header.types.js').CcAddonHeaderStateLoaded} CcAddonHeaderStateLoaded | ||
| * @typedef {import('./cc-addon-header.types.js').CcAddonHeaderStateLoading} CcAddonHeaderStateLoading | ||
| * @typedef {import('./cc-addon-header.types.js').KubeInfo} KubeInfo | ||
| * @typedef {import('../cc-zone/cc-zone.types.js').ZoneStateLoaded} ZoneStateLoaded | ||
| * @typedef {import('../../lib/smart/smart-component.types.js').OnContextUpdateArgs<CcAddonHeader>} OnContextUpdateArgs | ||
| * @typedef {import('../../lib/send-to-api.js').ApiConfig} ApiConfig | ||
| */ | ||
|
|
||
| defineSmartComponent({ | ||
| selector: 'cc-addon-header[smart-mode=kubernetes]', | ||
| params: { | ||
| apiConfig: { type: Object }, | ||
| ownerId: { type: String }, | ||
| clusterId: { type: String }, | ||
| productStatus: { type: String, optional: true }, | ||
| }, | ||
|
|
||
| /** @param {OnContextUpdateArgs} args */ | ||
| onContextUpdate({ context, updateComponent, signal }) { | ||
| const { apiConfig, ownerId, clusterId, productStatus } = context; | ||
| const api = new Api({ apiConfig, ownerId, clusterId, signal }); | ||
|
|
||
| updateComponent('state', { | ||
| type: 'loading', | ||
| configLink: { | ||
| href: fakeString(15), | ||
| fileName: fakeString(15), | ||
| }, | ||
| productStatus: fakeString(4), | ||
| }); | ||
|
|
||
| // clear when the component handled by the smart is disconnected from the DOM | ||
| const kubeConfigFetchInterval = setInterval(() => { | ||
|
There was a problem hiding this comment. ❓ question: should we add an error toast when this fetch fails ? There was a problem hiding this comment. Could be nice, error that encourages to refresh the page maybe. |
||
| api | ||
| .getKubeConfig() | ||
| .then((kubeConfigUrl) => { | ||
| updateComponent( | ||
| 'state', | ||
| /** @param {CcAddonHeaderStateLoaded|CcAddonHeaderStateLoading} state */ | ||
| (state) => { | ||
| state.configLink = { | ||
| fileName: 'kubeconfig.yaml', | ||
| href: kubeConfigUrl, | ||
| }; | ||
| }, | ||
| ); | ||
| }) | ||
| .catch((error) => { | ||
| console.error(error); | ||
| notify({ | ||
| intent: 'danger', | ||
| message: i18n('cc-addon-header.error.fetch-kubeconfig'), | ||
| options: { | ||
| timeout: 0, | ||
| closeable: true, | ||
| }, | ||
| }); | ||
| updateComponent('state', { | ||
| type: 'error', | ||
| }); | ||
| }); | ||
| }, FIFTY_MINUTES); | ||
|
|
||
| signal.addEventListener('abort', () => { | ||
| clearInterval(kubeConfigFetchInterval); | ||
| }); | ||
|
|
||
| api | ||
| .getKubeInfoWithKubeConfig() | ||
| .then(({ kubeInfo, kubeConfigUrl, zone }) => { | ||
| updateComponent('state', { | ||
| type: 'loaded', | ||
| providerId: PROVIDER_ID, | ||
| providerLogoUrl: getAssetUrl('/logos/kubernetes.svg'), | ||
| name: kubeInfo.name, | ||
| id: kubeInfo.id, | ||
| zone, | ||
| configLink: { | ||
| href: kubeConfigUrl, | ||
| fileName: 'kubeconfig.yaml', | ||
| }, | ||
| productStatus, | ||
| deploymentStatus: /** @type {DeploymentStatus} */ (kubeInfo.status.toLowerCase()), | ||
| }); | ||
| }) | ||
| .catch((error) => { | ||
| console.error(error); | ||
| notifyError(i18n('cc-addon-header.error')); | ||
| updateComponent('state', { | ||
| type: 'error', | ||
| }); | ||
| }); | ||
| }, | ||
| }); | ||
|
|
||
| class Api { | ||
| /** | ||
| * @param {object} params | ||
| * @param {ApiConfig} params.apiConfig - API configuration | ||
| * @param {string} params.ownerId - Owner identifier | ||
| * @param {string} params.clusterId - Cluster identifier | ||
| * @param {AbortSignal} params.signal - Signal to abort calls | ||
| */ | ||
| constructor({ apiConfig, ownerId, clusterId, signal }) { | ||
| this._apiConfig = apiConfig; | ||
| this._ownerId = ownerId; | ||
| this._clusterId = clusterId; | ||
| this._signal = signal; | ||
| } | ||
|
|
||
| /** @returns {Promise<KubeInfo>} */ | ||
| _getKubeInfo() { | ||
| return getKubeInfo({ ownerId: this._ownerId, clusterId: this._clusterId }) | ||
| .then(sendToApi({ apiConfig: this._apiConfig, signal: this._signal, cacheDelay: ONE_SECOND })) | ||
| .then((kubeInfo) => { | ||
| if (kubeInfo.status === 'DELETED') { | ||
| throw new Error('This cluster has been deleted'); | ||
| } | ||
|
Comment on lines
+133
to
+135
There was a problem hiding this comment. Note to myself for tomorrow: should also filter out |
||
| return kubeInfo; | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @return {Promise<string>} | ||
| */ | ||
| getKubeConfig() { | ||
| return getKubeConfig({ ownerId: this._ownerId, clusterId: this._clusterId }) | ||
| .then(sendToApi({ apiConfig: this._apiConfig, signal: this._signal })) | ||
| .then(({ url }) => url); | ||
| } | ||
|
|
||
| async getKubeInfoWithKubeConfig() { | ||
| const kubeInfo = await this._getKubeInfo(); | ||
| const kubeConfigUrl = await this.getKubeConfig(); | ||
| /** @type ZoneStateLoaded */ | ||
| const zone = { | ||
| type: 'loaded', | ||
| name: 'par', | ||
| country: 'France', | ||
| countryCode: 'FR', | ||
| city: 'Paris', | ||
| displayName: null, | ||
| lat: 48.8566, | ||
| lon: 2.3522, | ||
| tags: ['for:applications', 'for:par-only', 'infra:clever-cloud'], | ||
| }; | ||
|
|
||
| return { kubeInfo, kubeConfigUrl, zone }; | ||
| } | ||
| } | ||
|
|
||
| // FIXME: remove and use the clever-client call from the new clever-client | ||
| /** @param {{ ownerId: string, clusterId: string }} params */ | ||
| function getKubeInfo(params) { | ||
| // no multipath for /self or /organisations/{id} | ||
| return Promise.resolve({ | ||
| method: 'get', | ||
| url: `/v4/kubernetes/organisations/${params.ownerId}/clusters/${params.clusterId}`, | ||
| // no queryParams | ||
| // no body | ||
| }); | ||
| } | ||
|
|
||
| // FIXME: remove and use the clever-client call from the new clever-client | ||
| /** @param {{ ownerId: string, clusterId: string }} params */ | ||
| function getKubeConfig(params) { | ||
| // no multipath for /self or /organisations/{id} | ||
| return Promise.resolve({ | ||
| method: 'get', | ||
| url: `/v4/kubernetes/organisations/${params.ownerId}/clusters/${params.clusterId}/kubeconfig/presigned-url`, | ||
| // no queryParams | ||
| // no body | ||
| }); | ||
| } | ||
This file contains hidden or 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,60 @@ | ||
| --- | ||
| kind: '🛠 Addon/<cc-addon-header>' | ||
| title: '💡 Smart (Kubernetes)' | ||
| --- | ||
| # 💡 Smart `<cc-addon-header smart-mode="kubernetes">` | ||
|
|
||
| ## ℹ️ Details | ||
|
|
||
| <table> | ||
| <tr><td><strong>Component </strong> <td><a href="🛠-addons-cc-addon-header--default-story"><code><cc-addon-header></code></a> | ||
| <tr><td><strong>Selector </strong> <td><code>cc-addon-header[smart-mode="kubernetes"]</code> | ||
| <tr><td><strong>Requires auth</strong> <td>Yes | ||
| </table> | ||
|
|
||
| ## ⚙️ Params | ||
|
|
||
| | Name | Type | Details | Default | | ||
| |------------------|-------------|------------------------------------------------------------------------------------------------|----------| | ||
| | `apiConfig` | `ApiConfig` | Object with API configuration (target host, tokens...) | | | ||
| | `ownerId` | `string` | UUID prefixed with orga_ | | | ||
| | `clusterId` | `string` | ID of the Kubernetes cluster prefixed with kubernetes_ | | | ||
| | `productStatus` | `string` | Maturity status of the product | Optional | | ||
|
|
||
|
|
||
| ```ts | ||
| interface ApiConfig { | ||
| API_HOST: string, | ||
| API_OAUTH_TOKEN: string, | ||
| API_OAUTH_TOKEN_SECRET: string, | ||
| OAUTH_CONSUMER_KEY: string, | ||
| OAUTH_CONSUMER_SECRET: string, | ||
| } | ||
| ``` | ||
|
|
||
| ## 🌐 API endpoints | ||
|
|
||
| | Method | URL | Cache? | | ||
| | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------- | | ||
| | `GET` | `/v4/kubernetes/organisations/${ownerId}/clusters/${clusterId}` | Default | | ||
| | `GET` | `/v4/kubernetes/organisations/${ownerId}/clusters/${clusterId}/kubeconfig/presigned-url` | Default (fetched every 50 mins) | | ||
|
|
||
|
|
||
| ## ⬇️️ Examples | ||
|
|
||
| ```html | ||
| <cc-smart-container context='{ | ||
| "apiConfig": { | ||
| API_HOST: "", | ||
| API_OAUTH_TOKEN: "", | ||
| API_OAUTH_TOKEN_SECRET: "", | ||
| OAUTH_CONSUMER_KEY: "", | ||
| OAUTH_CONSUMER_SECRET: "", | ||
| }, | ||
| "ownerId": "orga_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", | ||
| "clusterId": "kubernetes_XXXXXXXXXXXXXXXXXXXXXXX", | ||
| "productStatus": "", | ||
| }'> | ||
| <cc-addon-header smart-mode="kubernetes"></cc-addon-header> | ||
| </cc-smart-container> | ||
| ``` |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
question: isn't it a breaking change?