Merge pull request #66 from Cox-Automotive/template-role-types

adds documentation for using template role types
Cox-Automotive · Apr 12, 2021 · d739fab · d739fab
2 parents 0a2c9ce + 2dcbe5b
commit d739fab
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 4 deletions.
diff --git a/API.md b/API.md
@@ -264,6 +264,7 @@ Returns a Promise for the results of creating a new custom AWS IAM account role
     - .roleType <code>string</code> - The type of AWS role to use when creating the new role
     - .includeDefaultPolicy <code>number</code> - Whether to include the default policy in the new role (1 = yes, 0 = no)
     - .enableAlksAccess <code>boolean</code> - Whether the role has a machine identity
+    - .templateFields <code>Object</code> - An object whose keys are template variable names and values are the value to substitute for those template variables
 
 **Example**  
 ```js
@@ -280,6 +281,26 @@ alks.createRole({
   // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
 })
 ```
+**Example**  
+```js
+alks.createRole({
+  baseUrl: 'https://your.alks-host.com',
+  accessToken: 'abc123',
+  account: 'anAccount',
+  role: 'IAMAdmin',
+  roleName: 'awsRoleName',
+  roleType: 'Amazon EKS IRSA',
+  includeDefaultPolicy: 1,
+  enableAlksAccess: false,
+  templateFields: {
+    OIDC_PROVIDER: 'oidc.eks.us-east-1.amazonaws.com/id/88G998884RBAD6687HBE3GETY67FQE04',
+    K8S_NAMESPACE: 'myNamespace',
+    K8S_SERVICE_ACCOUNT: 'myServiceAccount'
+  }
+}).then((role) => {
+  // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
+})
+```
 <a name="alks+createNonServiceRole"></a>
 
 ### alks.createNonServiceRole(props) ⇒ [<code>Promise.&lt;customRole&gt;</code>](#customRole)

diff --git a/dist/alks.cjs.js b/dist/alks.cjs.js
@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.10.2";
+var version = "1.11.1";
 
 const Buffer = require('buffer').Buffer;
 const fetch = require('node-fetch');
@@ -282,6 +282,7 @@ class alks {
    * @param {string} props.roleType - The type of AWS role to use when creating the new role
    * @param {number} props.includeDefaultPolicy - Whether to include the default policy in the new role (1 = yes, 0 = no)
    * @param {boolean} props.enableAlksAccess - Whether the role has a machine identity
+   * @param {Object} props.templateFields - An object whose keys are template variable names and values are the value to substitute for those template variables
    * @returns {Promise<customRole>}
    * @example
    * alks.createRole({
@@ -296,6 +297,25 @@ class alks {
    * }).then((role) => {
    *   // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
    * })
+   * 
+   * @example
+   * alks.createRole({
+   *   baseUrl: 'https://your.alks-host.com',
+   *   accessToken: 'abc123',
+   *   account: 'anAccount',
+   *   role: 'IAMAdmin',
+   *   roleName: 'awsRoleName',
+   *   roleType: 'Amazon EKS IRSA',
+   *   includeDefaultPolicy: 1,
+   *   enableAlksAccess: false,
+   *   templateFields: {
+   *     OIDC_PROVIDER: 'oidc.eks.us-east-1.amazonaws.com/id/88G998884RBAD6687HBE3GETY67FQE04',
+   *     K8S_NAMESPACE: 'myNamespace',
+   *     K8S_SERVICE_ACCOUNT: 'myServiceAccount'
+   *   }
+   * }).then((role) => {
+   *   // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
+   * })
    */
   createRole(props) {
     return(this._doFetch('createRole', props).then((results) => {

diff --git a/dist/alks.esm.js b/dist/alks.esm.js
@@ -1,4 +1,4 @@
-var version = "1.10.2";
+var version = "1.11.1";
 
 const fetch = window.fetch.bind(window);
 
@@ -279,6 +279,7 @@ class alks {
    * @param {string} props.roleType - The type of AWS role to use when creating the new role
    * @param {number} props.includeDefaultPolicy - Whether to include the default policy in the new role (1 = yes, 0 = no)
    * @param {boolean} props.enableAlksAccess - Whether the role has a machine identity
+   * @param {Object} props.templateFields - An object whose keys are template variable names and values are the value to substitute for those template variables
    * @returns {Promise<customRole>}
    * @example
    * alks.createRole({
@@ -293,6 +294,25 @@ class alks {
    * }).then((role) => {
    *   // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
    * })
+   * 
+   * @example
+   * alks.createRole({
+   *   baseUrl: 'https://your.alks-host.com',
+   *   accessToken: 'abc123',
+   *   account: 'anAccount',
+   *   role: 'IAMAdmin',
+   *   roleName: 'awsRoleName',
+   *   roleType: 'Amazon EKS IRSA',
+   *   includeDefaultPolicy: 1,
+   *   enableAlksAccess: false,
+   *   templateFields: {
+   *     OIDC_PROVIDER: 'oidc.eks.us-east-1.amazonaws.com/id/88G998884RBAD6687HBE3GETY67FQE04',
+   *     K8S_NAMESPACE: 'myNamespace',
+   *     K8S_SERVICE_ACCOUNT: 'myServiceAccount'
+   *   }
+   * }).then((role) => {
+   *   // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
+   * })
    */
   createRole(props) {
     return(this._doFetch('createRole', props).then((results) => {

diff --git a/dist/alks.min.js b/dist/alks.min.js
diff --git a/dist/alks.umd.js b/dist/alks.umd.js
@@ -4,7 +4,7 @@
   (global = global || self, global.alks = factory());
 }(this, function () { 'use strict';
 
-  var version = "1.10.2";
+  var version = "1.11.1";
 
   var fetch = window.fetch.bind(window);
 
@@ -283,6 +283,7 @@
    * @param {string} props.roleType - The type of AWS role to use when creating the new role
    * @param {number} props.includeDefaultPolicy - Whether to include the default policy in the new role (1 = yes, 0 = no)
    * @param {boolean} props.enableAlksAccess - Whether the role has a machine identity
+   * @param {Object} props.templateFields - An object whose keys are template variable names and values are the value to substitute for those template variables
    * @returns {Promise<customRole>}
    * @example
    * alks.createRole({
@@ -297,6 +298,25 @@
    * }).then((role) => {
    * // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
    * })
+   * 
+   * @example
+   * alks.createRole({
+   * baseUrl: 'https://your.alks-host.com',
+   * accessToken: 'abc123',
+   * account: 'anAccount',
+   * role: 'IAMAdmin',
+   * roleName: 'awsRoleName',
+   * roleType: 'Amazon EKS IRSA',
+   * includeDefaultPolicy: 1,
+   * enableAlksAccess: false,
+   * templateFields: {
+   *   OIDC_PROVIDER: 'oidc.eks.us-east-1.amazonaws.com/id/88G998884RBAD6687HBE3GETY67FQE04',
+   *   K8S_NAMESPACE: 'myNamespace',
+   *   K8S_SERVICE_ACCOUNT: 'myServiceAccount'
+   * }
+   * }).then((role) => {
+   * // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
+   * })
    */
   alks.prototype.createRole = function createRole (props) {
     return(this._doFetch('createRole', props).then(function (results) {

diff --git a/index.d.ts b/index.d.ts
@@ -136,6 +136,7 @@ declare namespace ALKS {
     roleType: string;
     enableAlksAccess: boolean;
     includeDefaultPolicy: PseudoBoolean;
+    templateFields?: Record<string, string>;
   }
 
   export interface CreateNonServiceRoleProps extends Partial<AlksProps> {

diff --git a/src/alks.js b/src/alks.js
@@ -281,6 +281,7 @@ class alks {
    * @param {string} props.roleType - The type of AWS role to use when creating the new role
    * @param {number} props.includeDefaultPolicy - Whether to include the default policy in the new role (1 = yes, 0 = no)
    * @param {boolean} props.enableAlksAccess - Whether the role has a machine identity
+   * @param {Object} props.templateFields - An object whose keys are template variable names and values are the value to substitute for those template variables
    * @returns {Promise<customRole>}
    * @example
    * alks.createRole({
@@ -295,6 +296,25 @@ class alks {
    * }).then((role) => {
    *   // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
    * })
+   * 
+   * @example
+   * alks.createRole({
+   *   baseUrl: 'https://your.alks-host.com',
+   *   accessToken: 'abc123',
+   *   account: 'anAccount',
+   *   role: 'IAMAdmin',
+   *   roleName: 'awsRoleName',
+   *   roleType: 'Amazon EKS IRSA',
+   *   includeDefaultPolicy: 1,
+   *   enableAlksAccess: false,
+   *   templateFields: {
+   *     OIDC_PROVIDER: 'oidc.eks.us-east-1.amazonaws.com/id/88G998884RBAD6687HBE3GETY67FQE04',
+   *     K8S_NAMESPACE: 'myNamespace',
+   *     K8S_SERVICE_ACCOUNT: 'myServiceAccount'
+   *   }
+   * }).then((role) => {
+   *   // role.roleArn, role.denyArns, role.instanceProfileArn, role.addedRoleToInstanceProfile
+   * })
    */
   createRole(props) {
     return(this._doFetch('createRole', props).then((results) => {