BlueprintsAnvändareMaskinöversatt

Parametrar

De parametertyper en blueprint-mall kan deklarera, deras egenskaper, hur hemligheter genereras och härleds, och hur driftsättningsguiden visar var och en.

Egenskaper

Varje post i en malls lista parameters har:

Egenskap	Innehåll
`name`	Krävs och är unikt i mallen. Token refererar till den som `[%<name>%]`, och en Secret-parameter lagras i valvet under det här namnet
`type`	En av typerna nedan
`label`	Fältets etikett i guiden
`description`	Hjälptext under fältet
`default`	Värdet som används när den som driftsätter lämnar fältet tomt. Får innehålla token
`options`	Bara `Select`: de värden som erbjuds
`advanced`	`true` placerar fältet under Avancerade inställningar, hopfällt
`generate`, `generateLength`, `generateSpec`, `generateClaims`	Genererar värdet när inget anges — se Genererade värden
`derived`	Sätter ihop värdet av andra parametrar — se Härledda värden
`capability`	Bara `DeploymentSource`, och krävs där: `ImagePull`
`documentation`	En URL om den här parametern
`required`	Markerar fältet som obligatoriskt i guiden
`validation`	`pattern`, ett reguljärt uttryck, och `message`

Varken required eller validation upprätthålls när en blueprint driftsätts i dag: portalen markerar ett obligatoriskt fält men skickar utan det, och mönstret lagras men kontrolleras aldrig. Ge hellre en parameter ett fungerande default än att förlita dig på dem.

Typer

Alla värden skickas som strängar.

Typ	Innehåller	I guiden
`String`	Text	Ett textfält; platshållaren visar standardvärdet med instansnamnet ifyllt
`Secret`	Ett känsligt värde. Skrivs till instansens valv och läses av containrar via `secretRef`	Ett maskerat fält; med `generate` betyder tomt att värdet genereras, och Generera skapar ett värde i webbläsaren
`Boolean`	`true` eller `false`	En brytare
`Select`	Ett av `options`	En rullgardinslista, med standardvärdet märkt (rekommenderas)
`DataSize`	En storlek, till exempel `10Gi`	Ett storleksfält
`Annotations`	Text	Ett vanligt textfält; typen har inget eget fält
`DeploymentSource`	Id för ett privat register anslutet till boundaryn, eller tomt för en publik avbild. Används som en containers `sourceRef`	En väljare med boundaryns privata register, och Publik avbild — inga uppgifter behövs

Genererade värden

Med generate: true får en parameter som lämnas tom ett värde vid driftsättningen:

`generateSpec`	Värde
saknas	`generateLength` slumpmässiga bokstäver och siffror, 32 som standard
`base64`	`generateLength` slumpmässiga byte, 32 som standard, base64-kodade
`jwt`	En JSON Web Token signerad med HS256, med `generateClaims` samt `iat` och ett `exp` tio år fram. Den signeras med värdet av parametern `jwt_secret` — deklarera den först, med `generate: true` — eller med en slumpmässig nyckel när den saknas

Generering är tänkt för Secret-parametrar. En vanlig genererad hemlighet visas under Avancerade inställningar, där den som driftsätter kan skriva ett eget värde; en med generateSpec visas inte alls i guiden.

Härledda värden

derived sätter ihop ett värde av andra parametrar när alla är kända, genererade inräknade:

yaml

- name: db_url
  type: Secret
  label: Postgres URL
  derived: "postgresql://postgres:[%db_password_urlencoded%]@[%name%]-postgres:5432/postgres"

Ett härlett värde ersätter alltid det som den som driftsätter skickade, och guiden visar det inte. Ge det type: Secret när det innehåller en hemlighet: bara Secret-parametrar skrivs till valvet.

Var värdena hamnar

Varje parameter kan användas som token i instansen och dess hanterade resurser.
Varje Secret-parameter med ett värde — angivet, genererat eller härlett — skrivs till instansens valv under sitt namn, och en container läser den med secretRef: { vault: "[%instance_vault%]", key: <name> }, med namnet utskrivet.
Guiden räknar de parametrar den inte visar — genererade med generateSpec, eller härledda — och talar om för den som driftsätter att de genereras vid driftsättningen och lagras i valvet.