Mallformat

Dokument

En mall är ett enda YAML- eller JSON-dokument. Okända fält är fel.

En minimal mall:

apiVersion: blueprints.stackship.se/v2
kind: BlueprintTemplate

metadata:
  slug: hello
  title: Hello
  version: "1.0.0"
  category: Tools
  tags: [example]

parameters:
  - name: ingress_host
    type: String
    label: Public Hostname
    default: "[%name%].{{domain_suffix}}"

instance:
  components:
    - name: web
      computePlan: small
      containers:
        - name: web
          image: docker.io/nginxinc/nginx-unprivileged
          tag: "1.31-alpine"
          ports:
            - name: http
              port: 8080
          probes:
            readiness:
              type: http
              port: http
              path: /
  endpoints:
    - name: web
      component: web
      port: http
      hostname: "[%ingress_host%]"

Metadata

Hanterade resurser

Varje post i resources ber plattformen skapa en resurs innan containerinstansen skapas, och skriva dess anslutningsuppgifter till instansens valv. Alla fält godtar token.

En postgres-resurs exponerar dessa outputs:

Driftsättningen väntar upp till fem minuter på att databasen tar emot anslutningar innan den skapar containerinstansen. En container läser en uppgift via en secretRef till instansens valv:

resources:
  - name: db
    type: postgres
    availability: "[%db_availability%]"
    storage: 10Gi
    exposes:
      - output: connectionString
        vaultKey: connectionstring_db

env:
  - name: ConnectionStrings__Default
    secretRef: { vault: "[%instance_vault%]", key: connectionstring_db }

Outputs

Varje post i outputs har ett name, en label, en description, en type — string (standard) eller url — en flagga secret, och ett value med token. Outputs lagras med mallen, men portalen visar dem inte någonstans i dag.

Instans

instance är containerinstansen som ska skapas: components och endpoints, i den form som API:t för containerinstanser tar emot. Vad varje inställning gör beskrivs med containerinstanserna — se Skapa en containerinstans och Slutpunkter. Instansens egna regler, som högst 16 komponenter och 0 till 10 repliker, tillämpas när driftsättningen skapar den.

• sourceRef anger ett privat register anslutet till boundaryn som avbilden hämtas via — oftast en parameter av typen DeploymentSource, sourceRef: "[%registry%]". Tomt betyder en publik avbild.
• En container läser en hemlighet via secretRef med vault: "[%instance_vault%]" och parameterns namn, eller vaultKey för en resurs output, som key. vault måste vara exakt "[%instance_vault%]"; en mall som pekar ut något annat valv nekas.
• Steget Beräkning hos den som driftsätter anger computePlan och replicas per komponent; mallens värden är de standardvärden som visas där.
• minComputePlan är den minsta plan en komponent kan köras på. Steget Beräkning stänger av planer med mindre processor eller mindre minne, och driftsättningen nekar dem. Ange den för komponenter som inte klarar sig på en liten plan, så att den som inte känner till storlekarna inte kan välja en.

Villkor

condition på en komponent, en container, en init-container eller en slutpunkt anger en parameter av typen Boolean. Om den parametern inte är true utelämnas elementet innan något annat renderas, och en slutpunkt vars komponent utelämnades följer med. Ett villkor som anger en parameter som inte finns räknas som av.

Varning

Portalens steg Beräkning skickar inställningar för varje komponent som mallen deklarerar. När en komponents villkor utelämnar den misslyckas en driftsättning från portalen vid Create the container instance med The template has no component named '<component>'. Villkora hellre containrar, init-containrar eller slutpunkter än hela komponenter där det går.

Token

[%parameter%] i vilken sträng som helst i instance och resources — nycklar i en files-volym inräknade — ersätts vid driftsättningen.

• [%name%] är instansnamnet och [%instance_vault%] namnet på instansens valv. En mall som deklarerar parametrar med de namnen nekas.
• [%parameter:type:default%] använder default när det inte finns någon parameter med det namnet.
• [%parameter_urlencoded%] är parameterns värde URL-kodat, för att bygga URI:er av genererade lösenord.
• Parametrarnas standardvärden kan också innehålla token, till exempel default: "[%name%].example.com".
• En token som inget fyller i lämnas kvar exakt som den skrevs.

En token lägger in värdet i containerinstansens egna inställningar som klartext, läsbart för alla som kan läsa instansen. Skicka hemligheter via secretRef, aldrig som en token i ett env-värde.

Plattformsvärden

När plattformen läser en mall från ett förråd — plattformskatalogen eller en katalogkälla — ersätter den två värden i parametrarnas standardvärden, i outputs värden och i slutpunkters värdnamn och utfärdare:

En mall som sparas via API:t lagras som den skickades: skriv ut dessa värden i sin helhet där.

Förrådets struktur

Ett förråd publicerar en blueprint per katalog, under den mapp som källan eller plattformskatalogen pekar på:

blueprints/
  my-app/
    template.yaml
    icon.svg
  my-db/
    template.yaml

• Katalogens namn är blueprintens slug, oavsett vad metadata.slug säger.
• Ikonen är den första av icon.svg, icon.png, icon.jpg eller icon.webp som finns bredvid template.yaml. Finns ingen används metadata.icon.
• Varje katalog läses som en blueprint. En utan template.yaml, eller med en som inte går att tolka, hoppas över och de andra läses ändå in.
• Undermoduler klonas inte.