Add documentation about variables for deployments
[#168448485)](https://www.pivotaltracker.com/story/show/168448485)
@@ -77,6 +77,27 @@ kubectl get events -n cf-operator --watch
For now deployments have to be in the namespace the operator is running in.
+## Variables
+
+BOSH releases consume two types of variables, explicit and implicit ones.
+
+### Implicit Variables
+
+Implicit variables have to be created before creating a BOSH deployment resource.
+The [previous example](docs/examples/bosh-deployment/boshdeployment-with-custom-variable.yaml) creates a secret named `nats-deployment.var-custom-password`. That value will be used fill `((custom-password))` place holders in the BOSH manifest.
+
+The name of the secret has to follow this scheme: '<bosh-deployment-cr.name>.var-<variable-name>'
+
+Missing implicit variables are treated as an error.
+
+### Explicit Variables
+
+Explicit variables are explicitly defined in the [BOSH manifest](https://bosh.io/docs/manifest-v2/#variables). They are generated automatically upon deployment and stored in secrets.
+
+The naming scheme is the same as for implicit variables.
+
+If an explicit variable secret already exists, it will not be generated. This allows users to set their own passwords, etc.
+
## Development and Tests
For more information about the operator development, see [docs/development.md](docs/development.md)
