A simple web app written in Go that you can use for testing. It reads in an env
variable TARGET
and prints Hello ${TARGET}!
. If TARGET
is not specified,
it will use World
as the TARGET
.
- A Kubernetes cluster with Knative installed. Follow the installation instructions if you need to create one.
- Docker installed and running on your local machine, and a Docker Hub account configured (we'll use it for a container registry).
While you can clone all of the code from this directory, hello world apps are generally more useful if you build them step-by-step. The following instructions recreate the source files from this folder.
-
Create a new file named
helloworld.go
and paste the following code. This code creates a basic web server which listens on port 8080:package main import ( "fmt" "log" "net/http" "os" ) func handler(w http.ResponseWriter, r *http.Request) { log.Print("Hello world received a request.") target := os.Getenv("TARGET") if target == "" { target = "World" } fmt.Fprintf(w, "Hello %s!\n", target) } func main() { log.Print("Hello world sample started.") http.HandleFunc("/", handler) port := os.Getenv("PORT") if port == "" { port = "8080" } log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil)) }
-
In your project directory, create a file named
Dockerfile
and copy the code block below into it. For detailed instructions on dockerizing a Go app, see Deploying Go servers with Docker.# Use the offical Golang image to create a build artifact. # This is based on Debian and sets the GOPATH to /go. # https://hub.docker.com/_/golang FROM golang as builder # Copy local code to the container image. WORKDIR /go/src/github.com/knative/docs/helloworld COPY . . # Build the helloworld command inside the container. # (You may fetch or manage dependencies here, # either manually or with a tool like "godep".) RUN CGO_ENABLED=0 GOOS=linux go build -v -o helloworld # Use a Docker multi-stage build to create a lean production image. # https://docs.docker.com/develop/develop-images/multistage-build/#use-multi-stage-builds FROM alpine # Copy the binary to the production image from the builder stage. COPY --from=builder /go/src/github.com/knative/docs/helloworld/helloworld /helloworld # Service must listen to $PORT environment variable. # This default value facilitates local development. ENV PORT 8080 # Run the web service on container startup. CMD ["/helloworld"]
-
Create a new file,
service.yaml
and copy the following service definition into the file. Make sure to replace{username}
with your Docker Hub username.apiVersion: serving.knative.dev/v1alpha1 kind: Service metadata: name: helloworld-go namespace: default spec: runLatest: configuration: revisionTemplate: spec: container: image: docker.io/{username}/helloworld-go env: - name: TARGET value: "Go Sample v1"
Once you have recreated the sample code files (or used the files in the sample folder) you're ready to build and deploy the sample app.
-
Use Docker to build the sample code into a container. To build and push with Docker Hub, run these commands replacing
{username}
with your Docker Hub username:# Build the container on your local machine docker build -t {username}/helloworld-go . # Push the container to docker registry docker push {username}/helloworld-go
-
After the build has completed and the container is pushed to docker hub, you can deploy the app into your cluster. Ensure that the container image value in
service.yaml
matches the container you built in the previous step. Apply the configuration usingkubectl
:kubectl apply --filename service.yaml
-
Now that your service is created, Knative will perform the following steps:
- Create a new immutable revision for this version of the app.
- Network programming to create a route, ingress, service, and load balance for your app.
- Automatically scale your pods up and down (including to zero active pods).
-
Run the following command to find the external IP address for your service. The ingress IP for your cluster is returned. If you just created your cluster, you might need to wait and rerun the command until your service gets asssigned an external IP address.
# In Knative 0.2.x and prior versions, the `knative-ingressgateway` service was used instead of `istio-ingressgateway`. INGRESSGATEWAY=knative-ingressgateway # The use of `knative-ingressgateway` is deprecated in Knative v0.3.x. # Use `istio-ingressgateway` instead, since `knative-ingressgateway` # will be removed in Knative v0.4. if kubectl get configmap config-istio -n knative-serving &> /dev/null; then INGRESSGATEWAY=istio-ingressgateway fi kubectl get svc $INGRESSGATEWAY --namespace istio-system
Example:
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE xxxxxxx-ingressgateway LoadBalancer 10.23.247.74 35.203.155.229 80:32380/TCP,443:32390/TCP,32400:32400/TCP 2d
-
Run the following command to find the domain URL for your service:
kubectl get ksvc helloworld-go --output=custom-columns=NAME:.metadata.name,DOMAIN:.status.domain
Example:
NAME DOMAIN helloworld-go helloworld-go.default.example.com
-
Test your app by sending it a request. Use the following
curl
command with the domain URLhelloworld-go.default.example.com
andEXTERNAL-IP
address that you retrieved in the previous steps:curl -H "Host: helloworld-go.default.example.com" http://{EXTERNAL_IP_ADDRESS}
Example:
curl -H "Host: helloworld-go.default.example.com" http://35.203.155.229 Hello World: Go Sample v1!
Note: Add
-v
option to get more detail if thecurl
command failed.
To remove the sample app from your cluster, delete the service record:
kubectl delete --filename service.yaml