[{"data":1,"prerenderedAt":4},["ShallowReactive",2],{"docs:\u002Fdocs\u002Fgetting-started\u002Fproject-structure":3},"\u003Cp>A Klass8s project is a Symfony application, so it has Symfony&#39;s layout; Klass8s adds a convention for where manifest classes live and how they are named.\u003C\u002Fp>\n\u003Ch2 id=\"where-the-project-lives\">\u003Ca class=\"anchor\" href=\"#where-the-project-lives\" aria-label=\"Link to this section\">\u003C\u002Fa>Where the project lives\u003C\u002Fh2>\n\u003Cp>Two arrangements are common, and both work the same way:\u003C\u002Fp>\n\u003Cul>\n\u003Cli>\u003Cstrong>A \u003Ccode>k8s\u002F\u003C\u002Fcode> directory inside a service&#39;s repository.\u003C\u002Fstrong> The manifests change in the same pull request as the code they deploy: a new endpoint and its route, a new queue and its worker.\u003C\u002Fli>\n\u003Cli>\u003Cstrong>A repository of its own\u003C\u002Fstrong>, for what belongs to no single service: a gateway, operators, databases, secret stores, the Helm releases of third-party software.\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"the-layout\">\u003Ca class=\"anchor\" href=\"#the-layout\" aria-label=\"Link to this section\">\u003C\u002Fa>The layout\u003C\u002Fh2>\n\u003Cp>With the defaults, a project with two Apps looks like this (in a Phaenon project the sources are \u003Ccode>.phn\u003C\u002Fcode> files, compiled into \u003Ccode>.src\u002F\u003C\u002Fcode> beside \u003Ccode>src\u002F\u003C\u002Fcode>):\u003C\u002Fp>\n\u003Cfigure class=\"plain\">\u003Cdiv class=\"block-pane\">\u003Cbutton type=\"button\" class=\"copy\" data-copy aria-label=\"Copy the code\">Copy\u003C\u002Fbutton>\u003Cpre class=\"shiki shiki-themes klass8s-light klass8s-dark\" style=\"--k8s-light:#191b2e;--k8s-dark:#e7e9f2;--k8s-light-bg:#fbfbf8;--k8s-dark-bg:#181b33\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan>k8s\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── bin\u002Fconsole\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── composer.json\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── config\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   ├── bundles.php                 # FrameworkBundle, ProximityBundle, Klass8sBundle\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   ├── services.yaml               # autowiring, bindings, excluded directories\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   └── packages\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│       ├── klass8s.yaml            # optional: locations, behaviour flags, apps, Helm\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│       └── prod\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│           └── klass8s.yaml        # optional: values for APP_ENV=prod only\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── src\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   ├── Kernel.php\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   ├── K8S\u002F                        # manifest code: one directory per App\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   ├── Shop\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   │   ├── ShopApp.php         # the App\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   │   ├── Manifest\u002F           # one class per Kubernetes resource\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   │   │   ├── ApiDeployment.php\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   │   │   ├── ApiService.php\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   │   │   └── ApiConfigMap.php\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   │   ├── Container\u002F          # sidecar and init container classes, not services\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   │   └── Resources\u002F          # files the App reads: readFile('…') (ReadsResourceFiles)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   │   └── ShopSetup\u002F              # a second App: what must exist before the workloads\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   └── EventSubscriber\u002F            # rules for the whole build (Guide: Events)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── tests\u002F                          # render tests (Guide: Testing)\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>└── var\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>    └── k8s-manifests\u002F              # k8s:dump:* output, by environment\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Fdiv>\u003C\u002Ffigure>\n\u003Ch2 id=\"the-conventions-and-why\">\u003Ca class=\"anchor\" href=\"#the-conventions-and-why\" aria-label=\"Link to this section\">\u003C\u002Fa>The conventions, and why\u003C\u002Fh2>\n\u003Cp>\u003Cstrong>One App per unit that deploys together, one class per resource.\u003C\u002Fstrong> Apps and manifests are found because they are services: the skeleton&#39;s \u003Ccode>config\u002Fservices.yaml\u003C\u002Fcode> registers every class under \u003Ccode>src\u002F\u003C\u002Fcode>, autoconfiguration tags them, and Klass8s collects the tagged ones. A manifest belongs to the App whose namespace contains it: \u003Ccode>App\\K8S\\Shop\\Manifest\\ApiDeployment\u003C\u002Fcode> belongs to the App \u003Ccode>App\\K8S\\Shop\\ShopApp\u003C\u002Fcode>. Finding the class behind \u003Ccode>shop-api\u003C\u002Fcode> is a file search.\u003C\u002Fp>\n\u003Cp>\u003Cstrong>A setup App and a runtime App.\u003C\u002Fstrong> What must exist before a workload starts (an ExternalSecret, a schema migration Job) goes into its own App, which deploys first: \u003Ccode>shop-setup\u003C\u002Fcode>, then \u003Ccode>shop\u003C\u002Fcode>. An App is also what you render and apply as one (\u003Ccode>bin\u002Fconsole k8s:render:apps shop-setup\u003C\u002Fcode>), and every resource names its App in the \u003Ccode>klass8s.dev\u002Fapp\u003C\u002Fcode> annotation, which is how a deploy \u003Ca href=\"\u002Fdocs\u002Fdeploying\u002Frendering-and-deploying#ordering-a-deploy\">can order them\u003C\u002Fa>.\u003C\u002Fp>\n\u003Cp>\u003Cstrong>\u003Ccode>Container\u002F\u003C\u002Fcode> directories are not services.\u003C\u002Fstrong> Sidecar and init containers are classes you construct yourself, often with arguments, so \u003Ccode>config\u002Fservices.yaml\u003C\u002Fcode> excludes them:\u003C\u002Fp>\n\u003Cfigure class=\"plain\">\u003Cdiv class=\"block-bar\">\u003Cspan class=\"block-file\">config\u002Fservices.yaml\u003C\u002Fspan>\u003Cbutton type=\"button\" class=\"copy\" data-copy aria-label=\"Copy the code\">Copy\u003C\u002Fbutton>\u003C\u002Fdiv>\u003Cdiv class=\"block-pane\">\u003Cpre class=\"shiki shiki-themes klass8s-light klass8s-dark\" style=\"--k8s-light:#191b2e;--k8s-dark:#e7e9f2;--k8s-light-bg:#fbfbf8;--k8s-dark-bg:#181b33\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">services\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">    _defaults\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">        autowire\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#9A3D0C;--k8s-dark:#F3A978\"> true\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">        autoconfigure\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#9A3D0C;--k8s-dark:#F3A978\"> true\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">    App\\\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">        resource\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#0B6B55;--k8s-dark:#86D9BF\"> '..\u002Fsrc\u002F'\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">        exclude\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">            -\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#0B6B55;--k8s-dark:#86D9BF\"> '..\u002Fsrc\u002FKernel.php'\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#676C7E;--k8s-light-font-style:italic;--k8s-dark:#9095AD;--k8s-dark-font-style:italic\">            # Sidecar and init container classes take constructor arguments you pass yourself.\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">            -\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#0B6B55;--k8s-dark:#86D9BF\"> '..\u002Fsrc\u002FK8S\u002F*\u002FContainer\u002F'\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Fdiv>\u003C\u002Ffigure>\n\u003Cp>\u003Cstrong>Facts every manifest may need are bindings.\u003C\u002Fstrong> The environment, a gateway&#39;s name, a public hostname: bound once in \u003Ccode>config\u002Fservices.yaml\u003C\u002Fcode>, they reach any constructor that names the parameter. See \u003Ca href=\"\u002Fdocs\u002Fguide\u002Fconfiguration\">Configuration and DI\u003C\u002Fa>.\u003C\u002Fp>\n\u003Cp>\u003Cstrong>Files stay files.\u003C\u002Fstrong> An nginx.conf or a Fluent Bit pipeline that a ConfigMap carries lives in the App&#39;s \u003Ccode>Resources\u002F\u003C\u002Fcode> directory and is read with \u003Ccode>$this-&gt;app-&gt;readFile(&#39;configs\u002Fnginx.conf&#39;)\u003C\u002Fcode>, the app narrowed to \u003Ccode>ReadsResourceFiles\u003C\u002Fcode> first (\u003Ca href=\"\u002Fdocs\u002Fguide\u002Fapps#what-an-app-decides\">Apps\u003C\u002Fa>). See \u003Ca href=\"\u002Fdocs\u002Fguide\u002Fdynamic-manifests\">Dynamic manifests\u003C\u002Fa>.\u003C\u002Fp>\n\u003Ch2 id=\"klass8syaml\">\u003Ca class=\"anchor\" href=\"#klass8syaml\" aria-label=\"Link to this section\">\u003C\u002Fa>klass8s.yaml\u003C\u002Fh2>\n\u003Cp>The file is optional. Every key has a default, and Apps need no entry: an App class in the container is registered under its \u003Ccode>name()\u003C\u002Fcode>. The \u003Ccode>apps\u003C\u002Fcode> section exists to override (switch an App off, set its deploy priority, hand a manifest its own configuration data); the whole schema is in the \u003Ca href=\"\u002Fdocs\u002Freference\u002Fconfiguration\">configuration reference\u003C\u002Fa>.\u003C\u002Fp>\n\u003Cfigure class=\"plain\">\u003Cdiv class=\"block-bar\">\u003Cspan class=\"block-file\">config\u002Fpackages\u002Fklass8s.yaml\u003C\u002Fspan>\u003Cbutton type=\"button\" class=\"copy\" data-copy aria-label=\"Copy the code\">Copy\u003C\u002Fbutton>\u003C\u002Fdiv>\u003Cdiv class=\"block-pane\">\u003Cpre class=\"shiki shiki-themes klass8s-light klass8s-dark\" style=\"--k8s-light:#191b2e;--k8s-dark:#e7e9f2;--k8s-light-bg:#fbfbf8;--k8s-dark-bg:#181b33\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#676C7E;--k8s-light-font-style:italic;--k8s-dark:#9095AD;--k8s-dark-font-style:italic\"># Every key is optional; these are the defaults written out.\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">klass8s\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">    code_dir\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#0B6B55;--k8s-dark:#86D9BF\"> '%kernel.project_dir%\u002Fsrc\u002FK8S'\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#676C7E;--k8s-light-font-style:italic;--k8s-dark:#9095AD;--k8s-dark-font-style:italic\">          # where k8s:make:* writes new classes\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">    namespace_prefix\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#0B6B55;--k8s-dark:#86D9BF\"> 'App\\K8S\\'\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#676C7E;--k8s-light-font-style:italic;--k8s-dark:#9095AD;--k8s-dark-font-style:italic\">                     # their namespace\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--k8s-light:#2C3FCC;--k8s-dark:#A3AEFF\">    manifests_dir\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#5A5F73;--k8s-dark:#A7ABC0\">:\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#0B6B55;--k8s-dark:#86D9BF\"> '%kernel.project_dir%\u002Fvar\u002Fk8s-manifests'\u003C\u002Fspan>\u003Cspan style=\"--k8s-light:#676C7E;--k8s-light-font-style:italic;--k8s-dark:#9095AD;--k8s-dark-font-style:italic\"> # where k8s:dump:* writes YAML\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Fdiv>\u003C\u002Ffigure>\n\u003Ch2 id=\"naming\">\u003Ca class=\"anchor\" href=\"#naming\" aria-label=\"Link to this section\">\u003C\u002Fa>Naming\u003C\u002Fh2>\n\u003Cdiv class=\"table-wrap\">\u003Ctable>\u003Cthead>\u003Ctr>\u003Cth>Thing\u003C\u002Fth>\u003Cth>Convention\u003C\u002Fth>\u003Cth>Example\u003C\u002Fth>\u003C\u002Ftr>\u003C\u002Fthead>\u003Ctbody>\u003Ctr>\u003Ctd>App class\u003C\u002Ftd>\u003Ctd>\u003Ccode>&lt;Name&gt;App\u003C\u002Fcode> in \u003Ccode>src\u002FK8S\u002F&lt;Name&gt;\u002F\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ShopApp\u003C\u002Fcode>\u003C\u002Ftd>\u003C\u002Ftr>\n\u003Ctr>\u003Ctd>App name\u003C\u002Ftd>\u003Ctd>short, a valid DNS label\u003C\u002Ftd>\u003Ctd>\u003Ccode>shop\u003C\u002Fcode>\u003C\u002Ftd>\u003C\u002Ftr>\n\u003Ctr>\u003Ctd>Manifest class\u003C\u002Ftd>\u003Ctd>\u003Ccode>&lt;ShortName&gt;&lt;Kind&gt;\u003C\u002Fcode> in the App&#39;s \u003Ccode>Manifest\u002F\u003C\u002Fcode>\u003C\u002Ftd>\u003Ctd>\u003Ccode>ApiDeployment\u003C\u002Fcode>\u003C\u002Ftd>\u003C\u002Ftr>\n\u003Ctr>\u003Ctd>Resource name\u003C\u002Ftd>\u003Ctd>\u003Ccode>&lt;app&gt;-&lt;short name&gt;\u003C\u002Fcode>, at most 52 characters\u003C\u002Ftd>\u003Ctd>\u003Ccode>shop-api\u003C\u002Fcode>\u003C\u002Ftd>\u003C\u002Ftr>\n\u003Ctr>\u003Ctd>Dumped file\u003C\u002Ftd>\u003Ctd>\u003Ccode>apps\u002F&lt;app&gt;\u002F&lt;short name&gt;.&lt;kind&gt;.yaml\u003C\u002Fcode>, the kind in kebab case\u003C\u002Ftd>\u003Ctd>\u003Ccode>apps\u002Fshop\u002Fapi.deployment.yaml\u003C\u002Fcode>\u003C\u002Ftd>\u003C\u002Ftr>\u003C\u002Ftbody>\u003C\u002Ftable>\u003C\u002Fdiv>\n\u003Cp>The 52-character limit leaves room for the suffixes Kubernetes adds to the names of the objects it creates from a resource, such as a Deployment&#39;s ReplicaSets and pods.\u003C\u002Fp>\n\u003Cp>Next: \u003Ca href=\"\u002Fdocs\u002Fguide\u002Fapps\">Apps\u003C\u002Fa>.\u003C\u002Fp>\n",1794928319277]