1234826 - Add more docs for tc-secrets

Status: RESOLVED FIXED

(Taskcluster :: Services, defect)

Description

[Dustin J. Mitchell [:dustin] (he/him)]

More documentation, including a better README, would make the service more accessible.

Comment 1

[Dustin J. Mitchell [:dustin] (he/him)]

Also, per pete, explain how the service can be used to share secrets between tasks and dependent tasks

Comment 2

[Pete Moore [:pmoore][:pete]]

Thanks Dustin!

Also we should explain in the project README.md how to create a config file if you want to run tests (currently it says "From the project's base run npm test" but does not mention how to set up the config), and add operational information about how to restart the service etc if there are problems.

Comment 3

[Pete Moore [:pmoore][:pete]]

(In reply to Dustin J. Mitchell [:dustin] from comment #1)
> Also, per pete, explain how the service can be used to share secrets between
> tasks and dependent tasks

We should probably put that under http://docs.taskcluster.net/services/secrets/ (and consider linking there from README.md).

Comment 4

[Dustin J. Mitchell [:dustin] (he/him)]

https://github.com/taskcluster/taskcluster-secrets/commit/d471250d227407629168d32892b3ff749c68030b

Comment 5

[Pete Moore [:pmoore][:pete]]

It looks like for some reason, the deployment of taskcluster-secrets didn't update the references - see http://references.taskcluster.net/secrets/v1/api.json

I see in Heroku, that the deployment took place: "Deployed d471250"

https://github.com/taskcluster/taskcluster-secrets/compare/0d4301d...d471250 shows the updated references.

But for example, you see the description of the secrets service has not been updated in the api.json above.

I also can't see a way to access historic deployment logs from the heroku web interface; is this possible, are they retained? :/

Strange - I suspect a problem occurred when the deployment took place, and the node script maybe quietly failed to update the references, and therefore heroku thought the deployment was successful. This is my only hunch, at the moment.

Comment 6

[Dustin J. Mitchell [:dustin] (he/him)]

I think the references upload is a bigger, pre-existing problem - bug 1262804.