@rancher/shell 1.2.3 → 1.2.5

package/utils/v-sphere.ts

@@ -0,0 +1,277 @@
+import merge from 'lodash/merge';
+import { SECRET } from '@shell/config/types';
+import { PROVISIONING_PRE_BOOTSTRAP } from '@shell/store/features';
+
+export const VMWARE_VSPHERE = 'vmwarevsphere';
+
+type Rke2Component = {
+    versionInfo: any;
+    userChartValues: any;
+    chartVersionKey: (chartName: string) => string;
+    value: any;
+    isEdit: boolean;
+    provider: string;
+    $store: any,
+}
+
+type SecretDetails = {
+  generateName: string,
+  upstreamClusterName: string,
+  upstreamNamespace: string,
+  downstreamName: string,
+  downstreamNamespace: string,
+  json?: object,
+}
+type Values = any;
+
+type ChartValues = {
+    defaultValues: Values,
+    userValues: Values,
+    combined: Values,
+};
+
+const rootGenerateName = 'vsphere-secret-';
+
+type SecretJson = any;
+
+class VSphereUtils {
+  private async findSecret(
+    { $store }: Rke2Component, {
+      generateName, upstreamClusterName, upstreamNamespace, downstreamName, downstreamNamespace
+    }: SecretDetails): Promise<SecretJson | undefined> {
+    const secrets = await $store.dispatch('management/request', { url: `/v1/${ SECRET }/${ upstreamNamespace }?filter=metadata.name=${ generateName }` });
+
+    const applicableSecret = secrets.data?.filter((s: any) => {
+      return s.metadata.annotations['provisioning.cattle.io/sync-target-namespace'] === downstreamNamespace &&
+        s.metadata.annotations['provisioning.cattle.io/sync-target-name'] === downstreamName &&
+        s.metadata.annotations['rke.cattle.io/object-authorized-for-clusters'].includes(upstreamClusterName);
+    });
+
+    if (applicableSecret.length > 1) {
+      return Promise.reject(new Error(`Found multiple matching secrets (${ upstreamNamespace }/${ upstreamNamespace } for ${ upstreamClusterName }), this will cause synchronizing mishaps. Consider removing stale secrets from old clusters`));
+    }
+
+    return applicableSecret[0];
+  }
+
+  private async findOrCreateSecret(
+    rke2Component: Rke2Component,
+    {
+      generateName, upstreamClusterName, upstreamNamespace, downstreamName, downstreamNamespace, json
+    }: SecretDetails
+  ) {
+    const { $store } = rke2Component;
+
+    const secretJson = await this.findSecret(rke2Component, {
+      generateName,
+      upstreamClusterName,
+      upstreamNamespace,
+      downstreamName,
+      downstreamNamespace
+    }) || json;
+
+    return await $store.dispatch('management/create', secretJson);
+  }
+
+  private findChartValues({
+    versionInfo,
+    userChartValues,
+    chartVersionKey,
+  }: Rke2Component, chartName: string): ChartValues | undefined {
+    const chartValues = versionInfo[chartName]?.values;
+
+    if (!chartValues) {
+      return;
+    }
+    const userValues = userChartValues[chartVersionKey(chartName)];
+
+    return {
+      defaultValues: chartValues,
+      userValues,
+      combined:      merge({}, chartValues || {}, userValues || {})
+    };
+  }
+
+  private handleVsphereSecret({ $store, provider }: { $store: any, provider: string}): boolean {
+    if (provider !== VMWARE_VSPHERE) {
+      return false;
+    }
+
+    const isPrebootstrapEnabled = $store.getters['features/get'](PROVISIONING_PRE_BOOTSTRAP);
+
+    if (!isPrebootstrapEnabled) {
+      return false;
+    }
+
+    return true;
+  }
+
+  /**
+    * Create upstream vsphere cpi secret to sync downstream
+    */
+  async handleVsphereCpiSecret(rke2Component: Rke2Component) {
+    if (!this.handleVsphereSecret(rke2Component)) {
+      return;
+    }
+
+    const generateName = `${ rootGenerateName }cpi-`;
+    const downstreamName = 'rancher-vsphere-cpi-credentials';
+    const downstreamNamespace = 'kube-system';
+    const { value } = rke2Component;
+
+    // check values for cpi chart has 'use our method' checkbox
+    const { userValues, combined } = this.findChartValues(rke2Component, 'rancher-vsphere-cpi') || {};
+
+    if (!combined?.vCenter?.credentialsSecret?.generate) {
+      if (userValues?.vCenter?.username) {
+        userValues.vCenter.username = '';
+      }
+      if (userValues?.vCenter?.password) {
+        userValues.vCenter.password = '';
+      }
+
+      return;
+    }
+
+    // find values needed in cpi chart value - https://github.com/rancher/vsphere-charts/blob/main/charts/rancher-vsphere-cpi/questions.yaml#L16-L42
+    const { username, password, host } = combined.vCenter;
+
+    if (!username || !password || !host) {
+      throw new Error('vSphere CPI username, password and host are all required when generating a new secret');
+    }
+
+    // create secret as per https://github.com/rancher/vsphere-charts/blob/main/charts/rancher-vsphere-cpi/templates/secret.yaml
+    const upstreamClusterName = value.metadata.name;
+    const upstreamNamespace = value.metadata.namespace;
+    const secret = await this.findOrCreateSecret(rke2Component, {
+      generateName,
+      upstreamClusterName,
+      upstreamNamespace,
+      downstreamName,
+      downstreamNamespace,
+      json: {
+        type:     SECRET,
+        metadata: {
+          namespace: upstreamNamespace,
+          generateName,
+          labels:    {
+            'vsphere-cpi-infra': 'secret',
+            component:           'rancher-vsphere-cpi-cloud-controller-manager'
+          },
+          annotations: {
+            'provisioning.cattle.io/sync-target-namespace': downstreamNamespace,
+            'provisioning.cattle.io/sync-target-name':      downstreamName,
+            'rke.cattle.io/object-authorized-for-clusters': upstreamClusterName,
+            'provisioning.cattle.io/sync-bootstrap':        'true'
+          }
+        },
+      }
+    });
+
+    secret.setData(`${ host }.username`, username);
+    secret.setData(`${ host }.password`, password);
+
+    await secret.save();
+
+    // reset cpi chart values
+    if (!userValues.vCenter.credentialsSecret) {
+      userValues.vCenter.credentialsSecret = {};
+    }
+    userValues.vCenter.credentialsSecret.generate = false;
+    userValues.vCenter.credentialsSecret.name = downstreamName;
+    userValues.vCenter.username = '';
+    userValues.vCenter.password = '';
+  }
+
+  /**
+    * Create upstream vsphere csi secret to sync downstream
+    */
+  async handleVsphereCsiSecret(rke2Component: Rke2Component) {
+    if (!this.handleVsphereSecret(rke2Component)) {
+      return;
+    }
+
+    const generateName = `${ rootGenerateName }csi-`;
+    const downstreamName = 'rancher-vsphere-csi-credentials';
+    const downstreamNamespace = 'kube-system';
+    const { value } = rke2Component;
+
+    // check values for cpi chart has 'use our method' checkbox
+    const { userValues, combined } = this.findChartValues(rke2Component, 'rancher-vsphere-csi') || {};
+
+    if (!combined?.vCenter?.configSecret?.generate) {
+      if (userValues?.vCenter?.username) {
+        userValues.vCenter.username = '';
+      }
+      if (userValues?.vCenter?.password) {
+        userValues.vCenter.password = '';
+      }
+
+      return;
+    }
+
+    // find values needed in cpi chart value - https://github.com/rancher/vsphere-charts/blob/main/charts/rancher-vsphere-csi/questions.yaml#L1-L36
+    const {
+      username, password, host, datacenters, port, insecureFlag
+    } = combined.vCenter;
+
+    if (!username || !password || !host || !datacenters) {
+      throw new Error('vSphere CSI username, password, host and datacenters are all required when generating a new secret');
+    }
+
+    // This is a copy of https://github.com/rancher/vsphere-charts/blob/a5c99d716df960dc50cf417d9ecffad6b55ca0ad/charts/rancher-vsphere-csi/values.yaml#L12-L21
+    // Which makes it's way into the secret via https://github.com/rancher/vsphere-charts/blob/main/charts/rancher-vsphere-csi/templates/secret.yaml#L8
+    let configTemplateString = '      [Global]\n      cluster-id = {{ required \".Values.vCenter.clusterId must be provided\" (default .Values.vCenter.clusterId .Values.global.cattle.clusterId) | quote }}\n      user = {{ .Values.vCenter.username | quote }}\n      password = {{ .Values.vCenter.password | quote }}\n      port = {{ .Values.vCenter.port | quote }}\n      insecure-flag = {{ .Values.vCenter.insecureFlag | quote }}\n\n      [VirtualCenter {{ .Values.vCenter.host | quote }}]\n      datacenters = {{ .Values.vCenter.datacenters | quote }}';
+
+    configTemplateString = configTemplateString.replace('{{ required \".Values.vCenter.clusterId must be provided\" (default .Values.vCenter.clusterId .Values.global.cattle.clusterId) | quote }}', `"{{clusterId}}"`);
+    configTemplateString = configTemplateString.replace('{{ .Values.vCenter.username | quote }}', `"${ username }"`);
+    configTemplateString = configTemplateString.replace('{{ .Values.vCenter.password | quote }}', `"${ password }"`);
+    configTemplateString = configTemplateString.replace('{{ .Values.vCenter.port | quote }}', `"${ port }"`);
+    configTemplateString = configTemplateString.replace('{{ .Values.vCenter.insecureFlag | quote }}', `"${ insecureFlag }"`);
+    configTemplateString = configTemplateString.replace('{{ .Values.vCenter.host | quote }}', `"${ host }"`);
+    configTemplateString = configTemplateString.replace('{{ .Values.vCenter.datacenters | quote }}', `"${ datacenters }"`);
+    // create secret as per https://github.com/rancher/vsphere-charts/blob/main/charts/rancher-vsphere-csi/templates/secret.yaml
+    const upstreamClusterName = value.metadata.name;
+    const upstreamNamespace = value.metadata.namespace;
+
+    const secret = await this.findOrCreateSecret(rke2Component, {
+      generateName,
+      upstreamClusterName,
+      upstreamNamespace,
+      downstreamName,
+      downstreamNamespace,
+      json: {
+        type:     SECRET,
+        metadata: {
+          namespace:   upstreamNamespace,
+          generateName,
+          annotations: {
+            'provisioning.cattle.io/sync-target-namespace': downstreamNamespace,
+            'provisioning.cattle.io/sync-target-name':      downstreamName,
+            'rke.cattle.io/object-authorized-for-clusters': upstreamClusterName,
+            'provisioning.cattle.io/sync-bootstrap':        'true'
+          }
+        },
+      }
+    });
+
+    secret.setData(`csi-vsphere.conf`, configTemplateString);
+
+    await secret.save();
+
+    // reset csi chart values
+    if (!userValues.vCenter.configSecret) {
+      userValues.vCenter.configSecret = {};
+    }
+    userValues.vCenter.configSecret.generate = false;
+    userValues.vCenter.configSecret.name = downstreamName;
+    userValues.vCenter.username = '';
+    userValues.vCenter.password = '';
+    userValues.vCenter.host = '';
+    userValues.vCenter.datacenters = '';
+  }
+}
+
+const utils = new VSphereUtils();
+
+export default utils;

package/creators/app/app.package.json

@@ -1,13 +0,0 @@
-{
-  "name": "NAME",
-  "version": "0.1.0",
-  "private": false,
-  "engines": {
-    "node": ">=12"
-  },
-  "dependencies": {},
-  "resolutions": {
-    "**/webpack": "4",
-    "@types/node": "^16"
-  }  
-}

package/creators/app/files/.eslintignore

@@ -1,18 +0,0 @@
-assets/fonts
-coverage
-.nyc_output
-node_modules/
-.npm
-.eslintcache
-.env
-.cache
-.next
-.nuxt
-dist
-dist-pkg
-.DS_Store
-dynamic-importer.js
-ksconfig.json
-nuxt.config.js
-shell/utils/dynamic-importer.js
-shell/assets/fonts

package/creators/app/files/.eslintrc.js

@@ -1,173 +0,0 @@
-module.exports = {
-  root: true,
-  env:  {
-    browser: true,
-    node:    true
-  },
-  globals: { NodeJS: true, Timer: true },
-  extends: [
-    'standard',
-    'eslint:recommended',
-    '@nuxtjs/eslint-config-typescript',
-    'plugin:cypress/recommended'
-  ],
-  // add your custom rules here
-  rules: {
-    'dot-notation':             'off',
-    'generator-star-spacing':   'off',
-    'guard-for-in':             'off',
-    'linebreak-style':          'off',
-    'new-cap':                  'off',
-    'no-empty':                 'off',
-    'no-extra-boolean-cast':    'off',
-    'no-new':                   'off',
-    'no-plusplus':              'off',
-    'no-useless-escape':        'off',
-    'nuxt/no-cjs-in-config':    'off',
-    'semi-spacing':             'off',
-    'space-in-parens':          'off',
-    strict:                     'off',
-    'unicorn/no-new-buffer':    'off',
-    'vue/html-self-closing':    'off',
-    'vue/no-unused-components': 'warn',
-    'vue/no-v-html':            'error',
-    'wrap-iife':                'off',
-
-    'array-bracket-spacing':             'warn',
-    'arrow-parens':                      'warn',
-    'arrow-spacing':                     ['warn', { before: true, after: true }],
-    'block-spacing':                     ['warn', 'always'],
-    'brace-style':                       ['warn', '1tbs'],
-    'comma-dangle':                      ['warn', 'only-multiline'],
-    'comma-spacing':                     'warn',
-    curly:                               'warn',
-    eqeqeq:                              'warn',
-    'func-call-spacing':                 ['warn', 'never'],
-    'implicit-arrow-linebreak':          'warn',
-    indent:                              ['warn', 2],
-    'keyword-spacing':                   'warn',
-    'lines-between-class-members':       ['warn', 'always', { exceptAfterSingleLine: true }],
-    'multiline-ternary':                 ['warn', 'never'],
-    'newline-per-chained-call':          ['warn', { ignoreChainWithDepth: 4 }],
-    'no-caller':                         'warn',
-    'no-cond-assign':                    ['warn', 'except-parens'],
-    'no-console':                        'warn',
-    'no-debugger':                       'warn',
-    'no-eq-null':                        'warn',
-    'no-eval':                           'warn',
-    'no-trailing-spaces':                'warn',
-    'no-undef':                          'warn',
-    'no-unused-vars':                    'warn',
-    'no-whitespace-before-property':     'warn',
-    'object-curly-spacing':              ['warn', 'always'],
-    'object-property-newline':           'warn',
-    'object-shorthand':                  'warn',
-    'padded-blocks':                     ['warn', 'never'],
-    'prefer-arrow-callback':             'warn',
-    'prefer-template':                   'warn',
-    'quote-props':                       'warn',
-    'rest-spread-spacing':               'warn',
-    semi:                                ['warn', 'always'],
-    'space-before-function-paren':       ['warn', 'never'],
-    'space-infix-ops':                   'warn',
-    'spaced-comment':                    'warn',
-    'switch-colon-spacing':              'warn',
-    'template-curly-spacing':            ['warn', 'always'],
-    'yield-star-spacing':                ['warn', 'both'],
-
-    'key-spacing':              ['warn', {
-      align: {
-        beforeColon: false,
-        afterColon:  true,
-        on:          'value',
-        mode:        'minimum'
-      },
-      multiLine: {
-        beforeColon: false,
-        afterColon:  true
-      },
-    }],
-
-    'object-curly-newline':          ['warn', {
-      ObjectExpression:  {
-        multiline:     true,
-        minProperties: 3
-      },
-      ObjectPattern:     {
-        multiline:     true,
-        minProperties: 4
-      },
-      ImportDeclaration: {
-        multiline:     true,
-        minProperties: 5
-      },
-      ExportDeclaration: {
-        multiline:     true,
-        minProperties: 3
-      }
-    }],
-
-    'padding-line-between-statements': [
-      'warn',
-      {
-        blankLine: 'always',
-        prev:      '*',
-        next:      'return',
-      },
-      {
-        blankLine: 'always',
-        prev:      'function',
-        next:      'function',
-      },
-      // This configuration would require blank lines after every sequence of variable declarations
-      {
-        blankLine: 'always',
-        prev:      ['const', 'let', 'var'],
-        next:      '*'
-      },
-      {
-        blankLine: 'any',
-        prev:      ['const', 'let', 'var'],
-        next:      ['const', 'let', 'var']
-      }
-    ],
-
-    quotes: [
-      'warn',
-      'single',
-      {
-        avoidEscape:           true,
-        allowTemplateLiterals: true
-      },
-    ],
-
-    'space-unary-ops': [
-      'warn',
-      {
-        words:    true,
-        nonwords: false,
-      }
-    ],
-
-    // FIXME: The following is disabled due to new linter and old JS code. These should all be enabled and underlying issues fixed
-    'vue/order-in-components':              'off',
-    'vue/no-lone-template':                 'off',
-    'vue/v-slot-style':                     'off',
-    'vue/component-tags-order':             'off',
-    'vue/no-mutating-props':                'off',
-    '@typescript-eslint/no-unused-vars':    'off',
-    'array-callback-return':                'off',
-  },
-  overrides: [
-    {
-      files: ['*.js'],
-      rules: {
-        // FIXME: The following is disabled due to new linter and old JS code. These should all be enabled and underlying issues fixed
-        'prefer-regex-literals':                'off',
-        'vue/component-definition-name-casing': 'off',
-        'no-unreachable-loop':                  'off',
-        'computed-property-spacing':            'off',
-      }
-    }
-  ]
-};

package/creators/app/files/.gitignore

@@ -1,70 +0,0 @@
-# compiled output
-/dist
-/tmp
-/out-tsc
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# nyc test coverage
-.nyc_output
-
-# IDEs and editors
-.idea
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
-
-# IDE - VSCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-
-# misc
-.sass-cache
-connect.lock
-typings
-
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-
-# System Files
-.DS_Store
-Thumbs.db

package/creators/app/files/.vscode/settings.json

@@ -1,22 +0,0 @@
-{
-  "files.exclude": {
-    ".ackrc": true,
-    ".dockerignore": true,
-    ".drone.yml": true,
-    ".editorconfig": true,
-    ".eslintcache": true,
-    ".eslintignore": true,
-    ".eslintrc.js": true,
-    ".gitignore": true,
-    ".nuxt*": true,
-    ".nyc_output": true,
-    ".vscode": true,
-    "LICENSE": true,
-    "node_modules": true,
-    "babel.config.js": true,
-    "jsconfig.json": true,
-    "yarn-error.log": true,
-    "pkg/**/.shell": true,
-    "pkg/**/node_modules": true,
-  }
-}

package/creators/app/files/babel.config.js

@@ -1 +0,0 @@
-module.exports = require('@rancher/shell/babel.config.js');

package/creators/app/files/tsconfig.json

@@ -1,42 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2018",
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "lib": [
-      "ESNext",
-      "ESNext.AsyncIterable",
-      "DOM"
-    ],
-    "esModuleInterop": true,
-    "allowJs": true,
-    "sourceMap": true,
-    "strict": true,
-    "noEmit": true,
-    "baseUrl": ".",
-    "paths": {
-      "~/*": [
-        "./*"
-      ],
-      "@/*": [
-        "./*"
-      ],
-      "@shell/*": [
-        "./node_modules/@rancher/shell/*"
-      ]
-    },
-    "typeRoots": [
-      "./node_modules",
-      "./node_modules/@rancher/shell/types"
-    ],    
-    "types": [
-      "@types/node",
-      "cypress",
-      "rancher",
-      "shell"
-    ]
-  },
-  "exclude": [
-    "node_modules"
-  ]
-}

package/creators/app/files/vue.config.js

@@ -1,6 +0,0 @@
-const config = require('@rancher/shell/vue.config');
-
-module.exports = config(__dirname, {
-  excludes: [],
-  // excludes: ['fleet', 'example']
-});