Skip to content

Latest commit

 

History

History
147 lines (110 loc) · 4.67 KB

README.md

File metadata and controls

147 lines (110 loc) · 4.67 KB

Hello World - Python sample

A simple web app written in Python that you can use for testing. It reads in an env variable TARGET and prints "Hello World: ${TARGET}!". If TARGET is not specified, it will use "NOT SPECIFIED" as the TARGET.

Prerequisites

  • 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).

Steps to recreate the sample code

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.

  1. Create a new directory and cd into it:

    mkdir app
    cd app
  2. Create a file named app.py and copy the code block below into it:

    import os
    
    from flask import Flask
    
    app = Flask(__name__)
    
    @app.route('/')
    def hello_world():
        target = os.environ.get('TARGET', 'NOT SPECIFIED')
        return 'Hello World: {}!\n'.format(target)
    
    if __name__ == "__main__":
        app.run(debug=True,host='0.0.0.0',port=8080)
  3. Create a file named Dockerfile and copy the code block below into it. See official Python docker image for more details.

    FROM python:alpine
    
    ENV APP_HOME /app
    COPY . $APP_HOME
    WORKDIR $APP_HOME
    
    RUN pip install Flask
    
    ENTRYPOINT ["python"]
    CMD ["app.py"]
    
  4. 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-python
      namespace: default
    spec:
      runLatest:
        configuration:
          revisionTemplate:
            spec:
              container:
                image: docker.io/{username}/helloworld-python
                env:
                - name: TARGET
                  value: "Python Sample v1"

Build and deploy this sample

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.

  1. 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-python .
    
    # Push the container to docker registry
    docker push {username}/helloworld-python
  2. 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 using kubectl:

    kubectl apply -f service.yaml
  3. 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).
  4. To find the IP address for your service, use kubectl get svc knative-ingressgateway -n istio-system to get the ingress IP for your cluster. If your cluster is new, it may take sometime for the service to get asssigned an external IP address.

    kubectl get svc knative-ingressgateway -n istio-system
    
    NAME                     TYPE           CLUSTER-IP     EXTERNAL-IP      PORT(S)                                      AGE
    knative-ingressgateway   LoadBalancer   10.23.247.74   35.203.155.229   80:32380/TCP,443:32390/TCP,32400:32400/TCP   2d
    
  5. To find the URL for your service, use

    kubectl get services.serving.knative.dev helloworld-python  -o=custom-columns=NAME:.metadata.name,DOMAIN:.status.domain
    NAME                DOMAIN
    helloworld-python   helloworld-python.default.example.com
    
  6. Now you can make a request to your app to see the result. Replace {IP_ADDRESS} with the address you see returned in the previous step.

    curl -H "Host: helloworld-python.default.example.com" http://{IP_ADDRESS}
    Hello World: Python Sample v1!

Remove the sample app deployment

To remove the sample app from your cluster, delete the service record:

kubectl delete -f service.yaml