Profile Tour Description Variables Guide

[Joka]

Hi Cloudlab,

after quite some time trying to find information on how to use placeholders/variables in a profile tour/description as seen here:

https://gitlab.flux.utah.edu/johnsond/k8s-profile/-/blob/master/profile.py?ref_type=heads#L295

I was wondering, whether there is a guide or a list of variables to be used? Especially displaying the public address for an experiment would be incredibly nice.

Kind Regards,
Johannes

[David M Johnson]

Hi Johannes. Thanks, sorry we don't already have that in the manual. I
committed some text that describe the two kinds of template variables
that we support, and include that text below in advance of the
production version of the manual being deployed.

You may use template variables in your profile “Instructions” text to
customize the instructions to an experiment. Currently, we support two
kinds of template variables: host and password. Host variables will
allow the Instructions template renderer to substitute a particular
node’s FQDN—recall that CloudLab FQDNs may be different for each
experiment, since they contain both the experiment and project names
as subdomains. For instance, if your profile includes a node named
node-0, you could refer to its FQDN in the Instructions via {host-
node-0}. You might use this to compose a URL to a service running on
one of your nodes, e.g. for demos. Password variables allow you to
expand specific random per-experiment passwords in the rendered
instructions. If your profile includes a random password named
perExptPassword, you can have it rendered in the generated
Instructions via {password-perExptPassword}.

> Johannes

David

[Joka]

Hi David,

thank you for your reply and no worries so far.

Forking your k8s profile I want to attempt keeping the well-written profile tour on track so people may continue using the fork with the best possible experience.

Johannes