[{"data":1,"prerenderedAt":375},["ShallowReactive",2],{"page-\u002Finstances\u002Fdeploy":3,"surround-\u002Finstances\u002Fdeploy":366},{"id":4,"title":5,"body":6,"description":358,"extension":359,"meta":360,"navigation":361,"path":362,"seo":363,"stem":364,"__hash__":365},"docs\u002Finstances\u002Fdeploy.md","Deploy an instance",{"type":7,"value":8,"toc":353},"minimark",[9,13,23,318,322,325,329,349],[10,11,12],"p",{},"This page explains each setting on the deploy page and its CLI flag, and what happens after you launch.",[14,15,17],"h2",{"id":16},"configure-and-launch",[18,19,22],"span",{"className":20},[21],"sr-only","Configure and launch",[24,25,27,186],"tabs",{"sync":26},"interface",[28,29,31,49],"tabs-item",{"label":30},"Console",[10,32,33,34,43,44,48],{},"On the ",[35,36,42],"a",{"href":37,"rel":38,"target":41},"https:\u002F\u002Fconsole.cloud.featherless.ai\u002Finstances",[39,40],"noopener","noreferrer","_blank","Instances page",", click ",[45,46,47],"strong",{},"Deploy instance",".",[50,51,53,58,78,82,102,106,128,132,139,143],"steps",{"level":52},"4",[54,55,57],"h4",{"id":56},"configure-deployment","Configure deployment",[59,60,61,68],"ul",{},[62,63,64,67],"li",{},[45,65,66],{},"Template",": a container image with its default settings, ready to deploy. You can pick an official template, one of yours, or one shared in your organization. Older releases of an official template are in the version menu next to its image.",[62,69,70,73,74,48],{},[45,71,72],{},"Set overrides",": replaces the template's image with another, such as your own, for this instance only. See ",[35,75,77],{"href":76},"\u002Ftemplates\u002Fcustom-images","Custom images",[54,79,81],{"id":80},"compute","Compute",[59,83,84],{},[62,85,86,89,90,93,94,97,98,101],{},[45,87,88],{},"GPU model"," and ",[45,91,92],{},"GPU count",", or ",[45,95,96],{},"CPU size",": each GPU comes with its own share of CPU and memory, which the ",[45,99,100],{},"Instance summary"," shows.",[54,103,105],{"id":104},"storage-configuration","Storage configuration",[59,107,108,119],{},[62,109,110,113,114,118],{},[45,111,112],{},"Container disk",": the instance's own disk. It holds the image, everything you install, and your files in ",[115,116,117],"code",{},"\u002Fworkspace",". It's erased when the instance stops or restarts, and it's billed only while the instance runs.",[62,120,121,124,125,127],{},[45,122,123],{},"Network volumes",": persistent storage that lives outside the instance, mounted at a path you choose, such as ",[115,126,117],{},". A volume keeps its data when instances stop or are deleted, and several instances can share it. Volumes can't be added or removed after you deploy, and an instance that mounts one runs in the volume's location.",[54,129,131],{"id":130},"public-ports","Public ports",[10,133,134,135,48],{},"HTTP ports in the container that get their own public HTTPS address, for a notebook, an API or a web app. Anyone with the address can reach them. Only HTTP traffic is carried, and you can change ports later without a restart. See ",[35,136,138],{"href":137},"\u002Finstances\u002Fports","Expose ports",[54,140,142],{"id":141},"runtime-configuration","Runtime configuration",[59,144,145,151,157,170,176],{},[62,146,147,150],{},[45,148,149],{},"Start command",": split on spaces and run without a shell. Left empty, the image's own command runs.",[62,152,153,156],{},[45,154,155],{},"Environment variables",": override a template's variables with the same name.",[62,158,159,162,163,166,167,48],{},[45,160,161],{},"Secret variables",": available as files under ",[115,164,165],{},"\u002Frun\u002Ffeatherless\u002Fsecrets",", not as environment variables. They can't be changed after you deploy. See ",[35,168,161],{"href":169},"\u002Ftemplates\u002Fcustom-images#read-secrets-in-your-code",[62,171,172,175],{},[45,173,174],{},"Auto start tmux in SSH sessions",": SSH logins join the same tmux session as the browser terminal.",[62,177,178,181,182,48],{},[45,179,180],{},"Install the featherless-cloud CLI",": the instance gets an API key that acts as you. Anything running in the instance can read it. See ",[35,183,185],{"href":184},"\u002Finstances\u002Fcli-access","Use the CLI in an instance",[28,187,189,293,308],{"label":188},"CLI",[190,191,196],"pre",{"className":192,"code":193,"language":194,"meta":195,"style":195},"language-bash shiki shiki-themes github-dark-default","featherless-cloud instance create \\\n  --name my-instance \\\n  --template featherless\u002Frocm-pytorch \\\n  --gpu-count 1 \\\n  --disk 100 \\\n  --volume my-data:\u002Fworkspace \\\n  --port 8888 \\\n  --env HF_HOME=\u002Fworkspace\u002Fhf\n","bash","",[115,197,198,217,229,240,251,262,273,284],{"__ignoreMap":195},[18,199,202,206,210,213],{"class":200,"line":201},"line",1,[18,203,205],{"class":204},"sQhOw","featherless-cloud",[18,207,209],{"class":208},"s9uIt"," instance",[18,211,212],{"class":208}," create",[18,214,216],{"class":215},"suJrU"," \\\n",[18,218,220,224,227],{"class":200,"line":219},2,[18,221,223],{"class":222},"sFSAA","  --name",[18,225,226],{"class":208}," my-instance",[18,228,216],{"class":215},[18,230,232,235,238],{"class":200,"line":231},3,[18,233,234],{"class":222},"  --template",[18,236,237],{"class":208}," featherless\u002Frocm-pytorch",[18,239,216],{"class":215},[18,241,243,246,249],{"class":200,"line":242},4,[18,244,245],{"class":222},"  --gpu-count",[18,247,248],{"class":222}," 1",[18,250,216],{"class":215},[18,252,254,257,260],{"class":200,"line":253},5,[18,255,256],{"class":222},"  --disk",[18,258,259],{"class":222}," 100",[18,261,216],{"class":215},[18,263,265,268,271],{"class":200,"line":264},6,[18,266,267],{"class":222},"  --volume",[18,269,270],{"class":208}," my-data:\u002Fworkspace",[18,272,216],{"class":215},[18,274,276,279,282],{"class":200,"line":275},7,[18,277,278],{"class":222},"  --port",[18,280,281],{"class":222}," 8888",[18,283,216],{"class":215},[18,285,287,290],{"class":200,"line":286},8,[18,288,289],{"class":222},"  --env",[18,291,292],{"class":208}," HF_HOME=\u002Fworkspace\u002Fhf\n",[10,294,295,296,299,300,303,304,307],{},"For CPU compute, use ",[115,297,298],{},"--compute-type cpu --cpu-cores 8",". To choose a GPU model, add ",[115,301,302],{},"--gpu-type \u003Cmodel>","; ",[115,305,306],{},"featherless-cloud pricing list"," shows the models on offer.",[10,309,310,311,317],{},"See ",[35,312,314],{"href":313},"\u002Fcli\u002Finstance#create-an-instance",[115,315,316],{},"instance create"," for every option.",[14,319,321],{"id":320},"after-you-launch","After you launch",[10,323,324],{},"Before the container starts, the instance waits for a GPU and downloads its image. The first start of an image can take a few minutes; later starts are faster. Billing is per second and starts when the container starts, not while you wait.",[14,326,328],{"id":327},"next-steps","Next steps",[330,331,332,341],"card-group",{},[333,334,338],"card",{"icon":335,"title":336,"to":337},"i-lucide-plug","Connect to an instance","\u002Finstances\u002Fconnect",[10,339,340],{},"Open a terminal or connect with SSH.",[333,342,346],{"icon":343,"title":344,"to":345},"i-lucide-box","Save it as a template","\u002Ftemplates\u002Fmanage",[10,347,348],{},"Reuse these settings for your next deploy.",[350,351,352],"style",{},"html pre.shiki code .sQhOw, html code.shiki .sQhOw{--shiki-default:#FFA657}html pre.shiki code .s9uIt, html code.shiki .s9uIt{--shiki-default:#A5D6FF}html pre.shiki code .suJrU, html code.shiki .suJrU{--shiki-default:#FF7B72}html pre.shiki code .sFSAA, html code.shiki .sFSAA{--shiki-default:#79C0FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}",{"title":195,"searchDepth":219,"depth":219,"links":354},[355,356,357],{"id":16,"depth":219,"text":22},{"id":320,"depth":219,"text":321},{"id":327,"depth":219,"text":328},"Launch an instance with the image, GPUs and storage your workload needs.","md",{},true,"\u002Finstances\u002Fdeploy",{"title":5,"description":358},"instances\u002Fdeploy","3raiLPpmMHigZCL_OYCvsLgCXuPJS0lpvxZHrVxrC9k",[367,371],{"title":368,"path":369,"description":370},"Instances overview","\u002Finstances","Develop, run notebooks, fine-tune and serve models on dedicated GPUs you control.",{"title":372,"path":373,"description":374},"Manage instances","\u002Finstances\u002Fmanage","Pay only for the instances you're using, and change or remove them as your work changes.",1794932598284]