Add GCP GKE support #209

mastoj · 2018-12-30T21:45:58Z

Adds support for kubernetes in general and Google Cloud Kubernetes Engine in particular.

Create docker tag from git sha
Publish docker image to google container registry
Auth with kubernetes cluster
Deploy as new app
Update existing app

The PR assumes two tools are pre-installed:

gcloud - cli tool to interact with gcp
kubectl - cli tool to interact with kubernetes

Given the above is installed and that you have a gcp project and gke cluster running. You can test this out by running:

dotnet new SAFE --deploy gcp-kubernetes
fake run build.fsx -t Deploy

Again, this serves as a way to getting started and will suffice for smaller apps.

mastoj · 2018-12-30T21:47:03Z

This has only been tested on OSX. No Windows machine available at the moment. I think it could work on Windows as well since I'm not using any shell commands.

mastoj · 2019-01-02T21:26:49Z

Updated PR to include the option to set the kubernetes cluster using -e SAFE_CLUSTER. If not set it will default to a kubernetes cluster named "safe-cluster".

Also, the FAKE tasks are structured so that the kubernetes specific ones can be used for any kubernetes cluster as long as kubectl is configured correctly.

theimowski · 2019-01-09T12:50:33Z

Content/paket.dependencies

@@ -64,4 +64,7 @@ group Build
    nuget Fake.IO.Zip
    github CompositionalIT/fshelpers src/FsHelpers/ArmHelper/ArmHelper.fs
 //#endif
+//#if (deploy == "gcp-kubernetes")
+    nuget Fake.Tools.Git


we'll need to add new case to paket lock generation for this - I can add that afterwards

sounds good, since I have no clue about how that part works.

Content/build.fsx

theimowski · 2019-01-10T12:03:03Z

Content/build.fsx

+Target.create "Publish" (fun _ ->
+    let dockerTag = createDockerTag dockerImageName
+    let pushArgs = sprintf "push %s" dockerTag
+    runTool "docker" pushArgs "."


unauthorized: You don't have the needed permissions to perform this operation, and you may have invalid credentials. To authenticate your request, follow the steps in: https://cloud.google.com/container-registry/docs/advanced-authentication <- should be probably reflected in docs?

I'll add, I guess I had already done that in my environment.

mastoj · 2019-01-11T21:55:23Z

It shouldn't be too hard to add kubernetes support for azure and aws after this I guess. Not sure how that works on those platforms, but I imagine it is similar.

theimowski · 2019-01-15T12:40:06Z

Can you rebase on master?

mastoj · 2019-01-15T12:51:25Z

Yes, that was my plan all along :).

…

On Tue, 15 Jan 2019 at 13:40, Tomasz Heimowski ***@***.***> wrote: Can you rebase on master? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#209 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAemsI8Dfz1giz5Yk7z0mXwzg1BBi9yIks5vDcwngaJpZM4ZlFcP> .

theimowski · 2019-01-16T12:10:03Z

Content/build.fsx

@@ -19,6 +19,10 @@ open Cit.Helpers.Arm
 open Cit.Helpers.Arm.Parameters
 open Microsoft.Azure.Management.ResourceManager.Fluent.Core
 //#endif
+//#if (deploy == "gcp-kubernetes")
+open System.Text.RegularExpressions
+open Fake.Tools.Git


Just thinking - is it really crucial to employ Git here? Can we find a different way to create a docker tag? Adding this dependency has 2 main drawbacks:

it implies the user needs to actually create git repo and commit before testing out the deployment

makes template a bit harder to maintain

It can be solved with a version variable. The reason I added it is because I see it as a good example of how to version your docker container based on your git sha, which does make some things around versioning slightly simpler in some scenarios, and also deterministic.

If it adds a lot of complexity I can, of course, figure something else out. What do you think based on motivation to why I added it in the first place @theimowski?

Yes I totally agree it's a go-to solution for deterministic tagging.
However in case of a template it's more steps for a user to try out functionality, and we strive to make the template as easy to use as possible and with minimal steps to deploy.

Can you push to Google Container Registry a docker image without tag (projectId/projectName instead of projectId/projectName:tag)?
If so maybe this could be the easiest way to start with. Otherwise - what would a "version variable" look like?

Content/build.fsx

mastoj · 2019-01-17T10:39:23Z

Rebased on master now.

mastoj · 2019-01-17T15:17:21Z

Yes, that is possible. But that might make the user confused when the try to make changes and nothing happen since the tag is still the same. The version could just be something simple as v1 used as rag for the container image. I can make it as simple as possible and instead write something about the more advanced tagging in the docs.

…

On Thu, 17 Jan 2019 at 13:18, Tomasz Heimowski ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In Content/build.fsx <#209 (comment)> : > @@ -19,6 +19,10 @@ open Cit.Helpers.Arm open Cit.Helpers.Arm.Parameters open Microsoft.Azure.Management.ResourceManager.Fluent.Core //#endif +//#if (deploy == "gcp-kubernetes") +open System.Text.RegularExpressions +open Fake.Tools.Git Yes I totally agree it's a go-to solution for deterministic tagging. However in case of a template it's more steps for a user to try out functionality, and we strive to make the template as easy to use as possible and with minimal steps to deploy. Can you push to Google Container Registry a docker image without tag ( projectId/projectName instead of projectId/projectName:tag)? If so maybe this could be the easiest way to start with. Otherwise - what would a "version variable" look like? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#209 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAemsDzpLrGVdrfTR2pM4q9UyWAyfIcDks5vEGohgaJpZM4ZlFcP> .

theimowski · 2019-01-17T16:04:38Z

I can make it as simple as possible and instead write something
about the more advanced tagging in the docs.

Please do - that would be my preference.

nothing happen since the tag is still the same

Is it really the case? I mean if you push the image with the same tag, doesn't it override the existing one in registry? I think that is what happens in case of Docker Hub for example.

mastoj · 2019-01-17T16:51:42Z

It overrides in the registry, yes, but I don’t think kubernetes consider the image as new if it has the same tag.

…

On Thu, 17 Jan 2019 at 17:04, Tomasz Heimowski ***@***.***> wrote: I can make it as simple as possible and instead write something about the more advanced tagging in the docs. Please do - that would be my preference. nothing happen since the tag is still the same Is it really the case? I mean if you push the image with the same tag, doesn't it override the existing one in registry? I think that is what happens in case of Docker Hub for example. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#209 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAemsKr_Z-JUMGxGZbVXFqJdH8jMsIJ-ks5vEJ8ZgaJpZM4ZlFcP> .

theimowski · 2019-01-18T12:13:51Z

If it doesn't, let's just mention that in docs. For the template what really matters is the first-time deploy.

mastoj · 2019-01-18T23:24:38Z

I've applied the changes and also verified that it indeed work the way I said. I'll update the docs later this weekend to reflect the changes and also with the suggestion on how to use the git sha for versioning.

theimowski · 2019-01-19T07:46:31Z

Thanks for that. I'm aware we might not be contributing to "best practices" here, however IMO it's crucial to find a right balance between simplicity and correctness for this template.

mastoj mentioned this pull request Jan 2, 2019

Gcp gke docs SAFE-Stack/docs#91

Merged

theimowski reviewed Jan 9, 2019

View reviewed changes

theimowski reviewed Jan 10, 2019

View reviewed changes

Content/build.fsx Show resolved Hide resolved

theimowski reviewed Jan 10, 2019

View reviewed changes

theimowski reviewed Jan 16, 2019

View reviewed changes

Content/build.fsx Outdated Show resolved Hide resolved

Tomas Jansson added 3 commits January 16, 2019 22:47

Add GCP GKE support

3a1a497

Optionally set cluster through env var

c926d1b

Fix so kubectl doesn't print error in log

e1f1924

mastoj force-pushed the gcp_gke_support branch from eb9654c to e1f1924 Compare January 16, 2019 21:47

Tomas Jansson added 2 commits January 17, 2019 09:56

runToolWithOutput only for gcp-kubernetes

364e5f0

Fix missing docker for appengine

213a2c4

Remove Fake.Tools.Git depedency

7c5abe9

theimowski merged commit 016565a into SAFE-Stack:master Jan 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add GCP GKE support #209

Add GCP GKE support #209

mastoj commented Dec 30, 2018 •

edited

Loading

mastoj commented Dec 30, 2018

mastoj commented Jan 2, 2019

theimowski Jan 9, 2019

mastoj Jan 9, 2019

theimowski Jan 10, 2019

mastoj Jan 10, 2019

mastoj commented Jan 11, 2019

theimowski commented Jan 15, 2019

mastoj commented Jan 15, 2019 via email

theimowski Jan 16, 2019

mastoj Jan 16, 2019

theimowski Jan 17, 2019

mastoj commented Jan 17, 2019

mastoj commented Jan 17, 2019 via email

theimowski commented Jan 17, 2019

mastoj commented Jan 17, 2019 via email

theimowski commented Jan 18, 2019

mastoj commented Jan 18, 2019

theimowski commented Jan 19, 2019

Add GCP GKE support #209

Add GCP GKE support #209

Conversation

mastoj commented Dec 30, 2018 • edited Loading

mastoj commented Dec 30, 2018

mastoj commented Jan 2, 2019

theimowski Jan 9, 2019

Choose a reason for hiding this comment

mastoj Jan 9, 2019

Choose a reason for hiding this comment

theimowski Jan 10, 2019

Choose a reason for hiding this comment

mastoj Jan 10, 2019

Choose a reason for hiding this comment

mastoj commented Jan 11, 2019

theimowski commented Jan 15, 2019

mastoj commented Jan 15, 2019 via email

theimowski Jan 16, 2019

Choose a reason for hiding this comment

mastoj Jan 16, 2019

Choose a reason for hiding this comment

theimowski Jan 17, 2019

Choose a reason for hiding this comment

mastoj commented Jan 17, 2019

mastoj commented Jan 17, 2019 via email

theimowski commented Jan 17, 2019

mastoj commented Jan 17, 2019 via email

theimowski commented Jan 18, 2019

mastoj commented Jan 18, 2019

theimowski commented Jan 19, 2019

mastoj commented Dec 30, 2018 •

edited

Loading