contentctl_default.yml template file missing in main branch

[obpedro]

Hi team,

First of all, love this tool and functionality. Learned about it at .conf23 and we are in the process of leveraging it internally.

While going through the setup process, I noticed that the contentctl_default.yml template file is missing from the main branch. It is present in other branches with what appears to be an older format. The file is linked from the README file which is how I found the issue. I figured this might have been an oversight so I thought to open an issue.

Thanks!

[pyth0n1c]

Hi @obpedro ! Thanks for raising this issue. The documentation is here is a bit out of date. Let me explain:

When you first run contentctl init we now create TWO configuration files. contentctl.yml and contentctl_test.yml . We've chosen to split these files up as both of them have grown quite long and, potentially, confusing. Happy to hear your feedback on whether we should keep these separate or combine them into one larger file.

The current way to see what apps are installed, and modify them, would be by making changes in the contentctl_test.yml file. In terms of precedence, we will try to use the local_path for installing each app here and, if you have not specified it, will fall back to using the http_path.

There is even support here for downloading your apps from Splunkbase, in which case we we download them for you at runtime! Unfortunately, right now this would require the inclusion of your splunkbase_username and splunkbase_password in plain text at the top of this file, which is why the functionality is current not well-documented. We will add support to include these credentials via command line or environment variable soon.

Please also note that when logging into the container we set up with contentctl test, you will need to use the splunk_app_password stored in this file as well.

I will leave this issue open since I need to:

1. Update the documentation with a correct, and better, explanation of the contentctl_test.yml file
2. Allow a number of more secure ways to pass credentials

[obpedro]

Thank you for the reply and the explanation! That makes sense. I think I was confused by seeing a link to contentctl_default.yml (not _test.yml).

It would be helpful to have a contentctl.yml/contentctl_test.yml with example values / a brief description of how to fill out some of the fields, what is valid vs what isn't, like the slack and email fields which expect a value in "dict" format. (haven't gotten these to work yet, so I've been leaving them set to the default of null). Most of the fields are self explanatory, but I've had a difficult time with some of them :)

Thanks again!

[smanaud]

Hello,

We use your nice tool (v3.0.2) and we wanted to know when you will add more secure ways to pass credentials when deploy app (instead of plain text in contenctl.yml).
We saw in the "https://github.com/splunk/contentctl/blob/main/contentctl/contentctl.py" file that "def api_deploy(args)" can get args but it's not documented to add username and password for example.
In this issue you talked about credentials "via command line or environment variable soon" so I post here !

Thank you very much !