Merge branch 'master' into cloudmap-1

Author: kiranmeduri

Makefile

@@ -7,6 +7,7 @@ GO111MODULE=on
 IMAGE=amazon/app-mesh-controller
 REPO=$(AWS_ACCOUNT).dkr.ecr.$(AWS_REGION).amazonaws.com/$(IMAGE)
 VERSION=v0.3.0
+DEV_VERSION=$(shell git describe --dirty --tags)
 
 .PHONY: eks-appmesh-controller
 eks-appmesh-controller:
@@ -23,7 +24,6 @@ linux:
 	mkdir -p _output/bin
 	CGO_ENABLED=0 GOOS=linux go build -ldflags ${LDFLAGS} -o _output/bin/app-mesh-controller ./cmd/app-mesh-controller
 
-
 .PHONY: code-gen
 code-gen:
 	./scripts/update-codegen.sh
@@ -34,7 +34,7 @@ verify-codegen:
 
 .PHONY: image
 image:
-	docker build -t $(IMAGE):latest .
+	docker build -t $(IMAGE):$(DEV_VERSION) .
 
 .PHONY: image-release
 image-release:
@@ -45,8 +45,8 @@ push:
 ifeq ($(AWS_ACCOUNT),)
 	$(error AWS_ACCOUNT is not set)
 endif
-	docker tag $(IMAGE):latest $(REPO):latest
-	docker push $(REPO):latest
+	docker tag $(IMAGE):$(DEV_VERSION) $(REPO):$(DEV_VERSION)
+	docker push $(REPO):$(DEV_VERSION)
 
 .PHONY: push-release
 push-release:
@@ -55,15 +55,7 @@ push-release:
 
 .PHONY: deploy
 deploy:
-	./scripts/deploy.sh
-
-.PHONY: example
-example:
-	./scripts/example.sh
-
-.PHONY: release-example-gen
-release-example-gen:
-	RELEASE=1 ./scripts/example.sh
+	./scripts/deploy.sh ${REPO}:${DEV_VERSION}
 
 .PHONY: clean
 clean:

README.md

@@ -11,9 +11,8 @@ AWS App Mesh Controller For K8s is a controller to help manage [App Mesh](https:
 
 ## Getting started
 
-Check out the [example](docs/example.md) application, and read [design and usage](docs/design.md).
-
-To begin using it in your cluster, follow the [install instructions](docs/install.md).
+- Install using steps under [install.md](./docs/install.md)
+- Follow the walkthroughs under [aws-app-mesh-examples](https://github.com/aws/aws-app-mesh-examples/tree/master/walkthroughs), e.g. [howto-k8s-fargate](https://github.com/aws/aws-app-mesh-examples/tree/master/walkthroughs/howto-k8s-fargate), [howto-k8s-retry-policy](https://github.com/aws/aws-app-mesh-examples/tree/master/walkthroughs/howto-k8s-retry-policy).
 
 ## Custom Resource Examples
 

deploy/controller-deployment.yaml.template

@@ -94,8 +94,6 @@ spec:
 ```
 the corresponding virtual node names in the App Mesh backend are, `colorteller-appmesh-demo`, `colorteller-blue-appmesh-demo`, and `colorteller-black-appmesh-demo` respectively.
 
-Check out the [example](example.md) application for more details.
-
 ## Cloud Map Service Discovery
 
 Cloud Map service discovery can be used in place of DNS. See this [App Mesh road map item](https://github.com/aws/aws-app-mesh-roadmap/issues/47).  In order to use it, you must specify the service discovery type as "cloudMap" in your virtual node definition.  For example,

docs/design.md

@@ -0,0 +1,38 @@
+# Development
+
+## Before you get started
+
+Please read the [contributing](../CONTRIBUTING.md) guidelines before getting started.
+
+## Guide
+
+Following steps will help you get ready with a local development stack to contribute and test your changes before publishing a PR.
+
+- Follow the [installation](install.md) steps. It is recommended to use the Helm to setup App Mesh controller.
+- Clone and checkout aws-app-mesh-controller-for-k8s.
+- Make code or configuration changes.
+- Run go-fmt
+```
+make go-fmt
+```
+- Build and push container image.
+```
+make image push
+```
+- Deploy latest changes to appmesh-controller
+```
+make deploy
+```
+- Use examples from [aws-app-mesh-examples](https://github.com/aws/aws-app-mesh-examples/tree/master/walkthroughs) to verify the controller behavior.
+
+## Updating App Mesh CRD
+
+Following steps can be used as a checklist when updating CRD to use the latest features available via App Mesh.
+
+- [ ] Update `aws-go-sdk` in go.mod to use the latest types from App Mesh
+- [ ] Update CRD schema in `deploy/all.yaml`
+- [ ] Update CRD structs in `pkg/apis/appmesh/v1beta1/types.go`
+- [ ] Update deepcopy functions using `make code-gen`
+- [ ] Update App Mesh client wrapper `pkg/aws/appmesh.go`
+- [ ] Update controller(s) under `pkg/controller/`
+