https://www.quickcase.app/assets/js/e3710a9b.68324aab.js

1"use strict";(self.webpackChunk_quickcase_docs=self.webpackChunk_quickcase_docs||[]).push([[9851],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?r(Object(n),!0).forEach((function(t){i(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):r(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function o(e,t){if(null==e)return{};var n,a,i=function(e,t){if(null==e)return{};var n,a,i={},r=Object.keys(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a<r.length;a++)n=r[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=a.createContext({}),s=function(e){var t=a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},u=function(e){var t=s(e.components);return a.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,c=e.parentName,u=o(e,["components","mdxType","originalType","parentName"]),p=s(n),m=i,k=p["".concat(c,".").concat(m)]||p[m]||d[m]||r;return n?a.createElement(k,l(l({ref:t},u),{},{components:n})):a.createElement(k,l({ref:t},u))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=m;var o={};for(var c in t)hasOwnProperty.call(t,c)&&(o[c]=t[c]);o.originalType=e,o[p]="string"==typeof e?e:i,l[1]=o;for(var s=2;s<r;s++)l[s]=n[s];return a.createElement.apply(null,l)}return a.createElement.apply(null,n)}m.displayName="MDXCreateElement"},3753:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>d,frontMatter:()=>r,metadata:()=>o,toc:()=>s});var a=n(7462),i=(n(7294),n(3905));const r={title:"QuickCase helm chart functions",sidebar_label:"Chart functions",sidebar_position:30},l="Helm Functions",o={unversionedId:"deployment/kubernetes/chart-functions",id:"deployment/kubernetes/chart-functions",title:"QuickCase helm chart functions",description:"In addition to standard Helm chart functions we add the following for the QuickCase chart:",source:"@site/docs/deployment/kubernetes/chart-functions.md",sourceDirName:"deployment/kubernetes",slug:"/deployment/kubernetes/chart-functions",permalink:"/docs/deployment/kubernetes/chart-functions",draft:!1,tags:[],version:"current",sidebarPosition:30,frontMatter:{title:"QuickCase helm chart functions",sidebar_label:"Chart functions",sidebar_position:30},sidebar:"docs",previous:{title:"Chart overview",permalink:"/docs/deployment/kubernetes/chart-overview"},next:{title:"Chart contract",permalink:"/docs/deployment/kubernetes/chart-contract"}},c={},s=[{value:"Naming convention",id:"naming-convention",level:2},{value:"OIDC functions",id:"oidc-functions",level:2},{value:"quickcase.oidc.uris.env",id:"quickcase-oidc-uris-env",level:3},{value:"quickcase.oidc.claims.env",id:"quickcase-oidc-claims-env",level:3},{value:"quickcase.oidc.env",id:"quickcaseoidcenv",level:3},{value:"quickcase.oidc.urlParams (internal)",id:"quickcaseoidcurlparams-internal",level:3},{value:"Database functions",id:"database-functions",level:2},{value:"quickcase.store.datasourceUrl",id:"quickcasestoredatasourceurl",level:3}],u={toc:s},p="wrapper";function d(e){let{components:t,...n}=e;return(0,i.kt)(p,(0,a.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"helm-functions"},"Helm Functions"),(0,i.kt)("p",null,"In addition to standard Helm chart functions we add the following for the QuickCase chart:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#oidc-functions"},"OIDC")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"#database-functions"},"Database"))),(0,i.kt)("h2",{id:"naming-convention"},"Naming convention"),(0,i.kt)("p",null,"Any custom functions are available and namespaced as follows:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"quickcase - these are considered globally accessible and stored in appropriate template files such as ",(0,i.kt)("inlineCode",{parentName:"li"},"_oidc.tpl")),(0,i.kt)("li",{parentName:"ul"},"app-name - these are considered application specific (even though they would be available globally). These are stored in ",(0,i.kt)("inlineCode",{parentName:"li"},"app-name/_app_name.tpl")," or similar.")),(0,i.kt)("h2",{id:"oidc-functions"},"OIDC functions"),(0,i.kt)("h3",{id:"quickcase-oidc-uris-env"},"quickcase.oidc.uris.env"),(0,i.kt)("p",null,"Provides the URIs used by the OIDC providers. Applications deployed with this function will have these environment variables set:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_JWKSETURI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_LOGINURI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_LOGOUTURI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_TOKENURI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_USERINFOURI")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_OPENIDSCOPE"))),(0,i.kt)("h3",{id:"quickcase-oidc-claims-env"},"quickcase.oidc.claims.env"),(0,i.kt)("p",null,"Sets various claim variables for use by the QuickCase OIDC library.  The following environment variables are set:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_PREFIX")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_SUB")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_NAME")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_EMAIL")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_ROLES")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_ORGANISATIONS")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_DEFAULTJURISDICTION")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_DEFAULTCASETYPE")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"QUICKCASE_OIDC_CLAIMS_NAMES_DEFAULTSTATE"))),(0,i.kt)("h3",{id:"quickcaseoidcenv"},"quickcase.oidc.env"),(0,i.kt)("p",null,"Wraps ",(0,i.kt)("a",{parentName:"p",href:"#quickcase-oidc-uris-env"},"quickcase.oidc.uris.env")," and ",(0,i.kt)("a",{parentName:"p",href:"#quickcase-oidc-claims-env"},"quickcase.oidc.claims.env")," into a single function for applications that need to consume both."),(0,i.kt)("h3",{id:"quickcaseoidcurlparams-internal"}

1,"quickcase.oidc.urlParams (internal)"),(0,i.kt)("p",null,"Used internally for ",(0,i.kt)("inlineCode",{parentName:"p"},"QUICKCASE_OIDC_LOGINURI")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"QUICKCASE_OIDC_LOGOUTURI")," to provide any URL parameters."),(0,i.kt)("h2",{id:"database-functions"},"Database functions"),(0,i.kt)("p",null,"Provides functions to easily configure access to the databases."),(0,i.kt)("h3",{id:"quickcasestoredatasourceurl"},"quickcase.store.datasourceUrl"),(0,i.kt)("p",null,"Constructs a JDBC datasource URL from database settings supplied to the function."),(0,i.kt)("p",null,"Parameters:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"The datastore being used either:"),(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},".Values.store.cases")," or"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},".Values.store.definitions"),".")))),(0,i.kt)("p",null,"Output:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"JDBC URL")))}d.isMDXComponent=!0}}]);