1"use strict";(self.webpackChunkgame_ci=self.webpackChunkgame_ci||[]).push([[1336],{3905:(e,t,r)=>{r.d(t,{Zo:()=>m,kt:()=>h});var a=r(67294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function i(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function l(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},o=Object.keys(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),u=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},m=function(e){var t=u(e.components);return a.createElement(s.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),c=u(r),d=n,h=c["".concat(s,".").concat(d)]||c[d]||p[d]||o;return r?a.createElement(h,i(i({ref:t},m),{},{components:r})):a.createElement(h,i({ref:t},m))}));function h(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:n,i[1]=l;for(var u=2;u<o;u++)i[u]=r[u];return a.createElement.apply(null,i)}return a.createElement.apply(null,r)}d.displayName="MDXCreateElement"},97566:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>p,frontMatter:()=>o,metadata:()=>l,toc:()=>u});var a=r(87462),n=(r(67294),r(3905));const o={},i="AWS",l={unversionedId:"github-orchestrator/examples/github-examples/aws",id:"version-3/github-orchestrator/examples/github-examples/aws",title:"AWS",description:"Requirements",source:"@site/versioned_docs/version-3/03-github-orchestrator/03-examples/02-github-examples/02-aws.mdx",sourceDirName:"03-github-orchestrator/03-examples/02-github-examples",slug:"/github-orchestrator/examples/github-examples/aws",permalink:"/docs/3/github-orchestrator/examples/github-examples/aws",draft:!1,editUrl:"https://github.com/game-ci/documentation/tree/main/versioned_docs/version-3/03-github-orchestrator/03-examples/02-github-examples/02-aws.mdx",tags:[],version:"3",sidebarPosition:2,frontMatter:{},sidebar:"defaultSidebar",previous:{title:"Command Line",permalink:"/docs/3/github-orchestrator/examples/command-line"},next:{title:"Kubernetes",permalink:"/docs/3/github-orchestrator/examples/github-examples/kubernetes"}},s={},u=[{value:"Requirements",id:"requirements",level:2},{value:"AWS Credentials",id:"aws-credentials",level:2},{value:"Configuration For AWS Orchestrator Jobs",id:"configuration-for-aws-orchestrator-jobs",level:2},{value:"Allowed CPU/Memory Combinations",id:"allowed-cpumemory-combinations",level:3},{value:"Summary Of Format",id:"summary-of-format",level:4},{value:"Valid CPU and Memory Values",id:"valid-cpu-and-memory-values",level:4},{value:"Example",id:"example",level:2}],m={toc:u},c="wrapper";function p(e){let{components:t,...r}=e;return(0,n.kt)(c,(0,a.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"aws"},"AWS"),(0,n.kt)("h2",{id:"requirements"},"Requirements"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"You must have an AWS account setup and ready to create resources."),(0,n.kt)("li",{parentName:"ul"},"Create a service account and generate an AWS access key and ke
1y id.")),(0,n.kt)("h2",{id:"aws-credentials"},"AWS Credentials"),(0,n.kt)("p",null,"Setup the following as ",(0,n.kt)("inlineCode",{parentName:"p"},"env")," variables for orchestrator to use:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"AWS_ACCESS_KEY_ID")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"AWS_SECRET_ACCESS_KEY")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"AWS_DEFAULT_REGION")," (should be the same AWS region as the base stack e.g ",(0,n.kt)("inlineCode",{parentName:"li"},"eu-west-2"),")")),(0,n.kt)("p",null,"If you're using GitHub you can use a GitHub Action:"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-yaml"},"- name: Configure AWS Credentials\n uses: aws-actions/configure-aws-credentials@v1\n with:\n aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}\n aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}\n aws-region: eu-west-2\n")),(0,n.kt)("p",null,(0,n.kt)("em",{parentName:"p"},"Note:")," ",(0,n.kt)("em",{parentName:"p"},"This enables Orchestrator access AWS.")),(0,n.kt)("h2",{id:"configuration-for-aws-orchestrator-jobs"},"Configuration For AWS Orchestrator Jobs"),(0,n.kt)("p",null,"Refer to ",(0,n.kt)("a",{parentName:"p",href:"../../api-reference"},"Configuration page")," or the ",(0,n.kt)("a",{parentName:"p",href:"#example"},"example below"),"."),(0,n.kt)("h3",{id:"allowed-cpumemory-combinations"},"Allowed CPU/Memory Combinations"),(0,n.kt)("p",null,"There are some limitations to the CPU and Memory parameters. AWS will only accept the following\ncombinations:\n",(0,n.kt)("a",{parentName:"p",href:"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size"},"AWS Fargate Documentation, Allowed CPU and memory values (Task Definitions)")),(0,n.kt)("h4",{id:"summary-of-format"},"Summary Of Format"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Values are represented as 1024:1 GB or CPU."),(0,n.kt)("li",{parentName:"ul"},"Do not include the vCPU or GB suffix."),(0,n.kt)("li",{parentName:"ul"},"1 CPU can go to a max of 6 GB of memory. 2 CPU's are required to go higher.")),(0,n.kt)("h4",{id:"valid-cpu-and-memory-values"},"Valid CPU and Memory Values"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-yaml"},"- orchestratorMemory: 4096\n- orchestratorCpu: 1024\n")),(0,n.kt)("h2",{id:"example"},"Example"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-yaml"},"- uses: game-ci/unity-builder@orchestrator-develop\n id: aws-fargate-unity-build\n with:\n providerStrategy: aws\n versioning: None\n projectPath: `your path here`\n unityVersion: `unity version here`\n targetPlatform: ${{ matrix.targetPlatform }}\n gitPrivateToken: ${{ secrets.GITHUB_TOKEN }}\n # You may want to export your builds somewhere external so you can access it:\n containerHookFiles: aws-s3-upload-build\n")),(0,n.kt)("p",null,(0,n.kt)("em",{parentName:"p"},(0,n.kt)("a",{parentName:"em",href:"../../advanced-topics/custom-hooks/container-hooks"},"Custom Steps"))),(0,n.kt)("p",null,"A full workflow example can be seen in builder's\n",(0,n.kt)("a",{parentName:"p",href:"https://github.com/game-ci/unity-builder/blob/309d668d637ae3e7ffe90d61612968db92e1e376/.github/workflows/orchestrator-pipeline.yml#L109"},"Orchestrator GitHub sourcecode for GitHub Pipeline"),"."))}p.isMDXComponent=!0}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.