Faas: Docs: write-up how to use a private registry with OpenFaaS on Kubernetes

[alexellis]

The docs site should have a new page or new paragraph added on how to use a private registry with Kubernetes.

• Link to how to deploy the registry in the K8s docs
• Show how to create an image pull secret
• Show an OpenFaaS YAML file with the secret added in the secrets section

Some of this has already been done in markdown in other markdown but can be condensed down.

https://github.com/openfaas/faas-netes/blob/master/SECRETS.md

Target repo - http://github.com/openfaas/docs

[ivanayov]

Derek assign: iyovcheva

[alexellis]

Please keep the docs information focused on the use of private images rather than on secrets as a generic topic. Don't use curl in the examples - this should just be kubectl and faas-cli.

On that note we should also add a separate page on the use of secrets.

[ericstoekl]

Shouldn't this issue be tracked in the docs repo?

[alexellis]

I have no problems with tracking it here since we have a lot of repositories much of the work is starting out in the faas repo which is the front-facing repo if that makes sense.

[jmo808]

If OpenFaaS is deployed on K8s there's a way to assign private registry login info to the namespace service account. I tested this by assigning the docker registry secret to the openfaas-fn namespace and then you can push the private images and k8s auto assigns the imagePullSecrets to the pod manifest. On AWS and GKE managed K8s their own private registry login info is already added to their managed node builds. AKS it has to be manually configured as described above (which would be the same instructions for non managed K8s). I can supply those documentation bits (which is merged from a couple of articles I found that led me to that solution).

[alexellis]

The method we have documented is to create a named image pull secret and then to have that referenced at the function level in the YAML file

@jmo808 it'd be good for you to add your solution to the final page too.

Here's an updated version of Lucas' markdown for us to trim down and take over to the docs site: https://github.com/LucasRoesler/faas-netes/blob/2a2868e9000b437bd5e2baa90598e2369bafd7d7/SECRETS.md

[jmo808]

I can get a markdown file created with my K8s solution and then it can be merged by whoever owns this doc. Or I can do a PR which ever is easiest.

[alexellis]

Sounds good to me

[alexellis]

Jules did you also receive your slack invitation?

[jmo808]

Yes, I did thanks! I'm in now.

[alexellis]

Maybe you could send your initial PR and markdown here? https://github.com/openfaas/faas-netes/blob/master/SECRETS.md Then we could take it over to the new docs site from there.

Do you use Swarm in any of your work?

[ivanayov]

@jmo808 Can you please send your PR on this as well - docs/pull#6 ?

[jmo808]

Ok. I will switch to your branch and add the service account info to that doc if that works for you.

From: iyovcheva
Sent: Tuesday, April 10, 2018 8:37 AM
To: openfaas/faas
Cc: Jules Ouellette; Mention
Subject: Re: [openfaas/faas] Docs: write-up how to use a private registry withOpenFaaS on Kubernetes (#623)

@jmo808 Can you please send your PR on this as well - docs/pull#6 ?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.

[ivanayov]

Thanks @jmo808

[alexellis]

Hi @jmo808 we're going to merge Ivana's PR then you can send one onto that.

https://github.com/openfaas/docs/pull/6

[jmo808]

That sounds good. If it gets merged today I’ll add my bits.

Get Outlook for iOShttps://aka.ms/o0ukef

---

From: Alex Ellis [e-mail]
Sent: Tuesday, April 24, 2018 7:53:59 AM
To: openfaas/faas
Cc: Jules Ouellette; Mention
Subject: Re: [openfaas/faas] Docs: write-up how to use a private registry with OpenFaaS on Kubernetes (#623)

Hi @jmo808https://github.com/jmo808 we're going to merge Ivana's PR then you can send one onto that.

openfaas/docs#6https://github.com/openfaas/docs/pull/6

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com/openfaas/faas/issues/623#issuecomment-383939185, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AGeGGaAWu45YxnUmBdDu8MDKbc0l4AKAks5try53gaJpZM4TGTB9.

[alexellis]

Sounds good! (It's merged now)

[burtonr]

Derek close: merged