Question
Using --user-data with doctl
- Posted on January 30, 2024
- Configuration ManagementDigitalOcean API and CLI (doctl)
Asked by biomechanico
I am trying to understand the --user-data flag in the doctl computer docker create command. It’s referenced here:
https://docs.digitalocean.com/reference/doctl/reference/compute/droplet/create/
I thought that something like this might work.
doctl compute droplet create \
--verbose \
--wait \
--image docker-20-04 \
--size c-2 \
--region sfo3 \
--user-data "#!/bin/bash\ndocker pull hello-world;" \
alpha-engine
But it doesn’t seem to work.
However, if I make a file (e.g. “hello.sh”) with contents
#!/bin/bash
docker pull hello-world
And then execute
doctl compute droplet create \
--verbose \
--wait \
--image docker-20-04 \
--size c-2 \
--region sfo3 \
--user-data-file hello.sh
alpha-engine
It seems to work.
I can’t really find much help on this topic but I appreciate any help I can get. I’d really like to understand the --user-data flag. I’ve tried variations (e.g. not including the #!/bin/bash\n) but haven’t found anything that works yet.
This textbox defaults to using Markdown to format your answer.
You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!
These answers are provided by our Community. If you find them useful, show some love by clicking the heart. If you run into issues leave a comment, or add your own answer to help others.
Get our biweekly newsletter
Sign up for Infrastructure as a Newsletter.
Hollie's Hub for Good
Working on improving health and education, reducing inequality, and spurring economic growth? We'd like to help.
Become a contributor
Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.
Hey!
From the issue you’re facing, it seems like the problem is with the way the user data script is being passed through the command line. When you provide the script directly in the command line, special characters like newline (
\n) are treated differently than when you provide them in a file. This might be causing your script to not execute as intended.Here’s a bit more insight and a suggestion:
When you use the
--user-dataflag directly in the command line, you need to ensure that the script is formatted correctly. However, complex scripts with multiple lines and special characters (like newline\n) can be tricky to pass in correctly due to shell interpretation.The approach that worked for you involves creating a script file and then using the
--user-data-fileflag. This is generally more reliable for complex scripts because it avoids issues with shell interpretation and allows you to format the script in a clear, readable manner.The error message from
/var/log/cloud-init-output.logsuggests that the script provided through--user-datawas not correctly interpreted as a valid script. The ‘text/x-not-multipart’ part indicates that cloud-init did not recognize the format of your user data.I would personally suggest that, for complex scripts or when you need to include special characters, it’s usually better to use the
--user-data-fileapproach. This ensures your script is read and executed exactly as you’ve written it, without any shell interpretation issues.However, if you still want to use the
--user-dataflag directly in the command line for simpler scripts, you need to pay close attention to how special characters are interpreted and make sure the script is correctly formatted as a single line. For example:In this revised command, the
$before the single quotes is used to tell the shell to interpret escape sequences like\n.Basically, the key to using
--user-dataeffectively is understanding how your shell interprets and formats the script you’re passing in. For more complex tasks, sticking to--user-data-fileis a more reliable and clearer approach.If you have more questions, feel free to ask!
Best,
Bobby