Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated #142

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Updated #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb44cc3
Updated the Trait to Gateway
sreejith-rajashekaran Jan 7, 2025
c8f9ec1
Updated the Trait to Gateway
sreejith-rajashekaran Jan 7, 2025
5622443
Updated the Trait to Gateway for sample 2
sreejith-rajashekaran Jan 20, 2025
9bbbf02
Updated the Trait to Gateway for sample 3
sreejith-rajashekaran Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 70 additions & 38 deletions 01.Helloworld/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,24 @@ get all the files mentioned here in the [app](./app) folder.
3. Create a file named `Dockerfile` and copy the code from
[`app/Dockerfile`](./app/Dockerfile), See [official Python docker
image](https://hub.docker.com/_/python/) for more details.
4. Use Docker to build the sample code into a container. To build and push with
Docker Hub, run these commands replacing `oamdev` with your Docker Hub
username
4. Login to your Docker Hub account, using the below command.
```shell script
docker login
```
This would direct you to click enter and it would open up a browser. Login to your Docker Hub account on the browser and the control would come back to CLI. You would get a success message if login was completed.
5. Use Docker to build the sample code into a container. To build and push with
Docker Hub, run these commands after updating your Docker Hub Username.

```shell script
# Build the container on your local machine
docker build -t oamdev/helloworld-python:v1 .
docker_hub_username = <your_docker_username>
docker build -t $docker_hub_username/helloworld-python:v1 .

# Push the container to docker registry
docker push oamdev/helloworld-python:v1
docker push $docker_hub_username/helloworld-python:v1
```

Now we have a docker image tagged `oamdev/helloworld-python:v1`.
Now we have a docker image tagged `<your_docker_username>/helloworld-python:v1`.

## Determine Component Type

Expand Down Expand Up @@ -94,19 +99,14 @@ vela traits

```console
NAME NAMESPACE APPLIES-TO CONFLICTS-WITH POD-DISRUPTIVE DESCRIPTION
annotations vela-system webservice,worker false Add annotations for your Workload.
cpuscaler vela-system webservice,worker false configure k8s HPA with CPU metrics for Deployment
ingress vela-system webservice,worker false Configures K8s ingress and service to enable web traffic for
your service. Please use route trait in cap center for
advanced usage.
labels vela-system webservice,worker false Add labels for your Workload.
scaler vela-system webservice,worker false Configures replicas for your service by patch replicas
field.
sidecar vela-system webservice,worker false inject a sidecar container into your app

gateway [deployments.apps statefulsets.apps] Enable public web traffic for the component, the ingress API
matches K8s v1.20+.
hostalias [deployments.apps statefulsets.apps daemonsets.apps Add host aliases on K8s pod for your workload which follows
jobs.batch] the pod spec in path 'spec.template'.
hpa [deployments.apps statefulsets.apps] Configure k8s HPA for Deployment or Statefulset
```

Apparently, `ingress` is exactly what we need.
Apparently, `gateway` is exactly what we need.

> Again, as an end-user, you are also supposed to know how to check the traits
> already installed on the platform and the usage of each.
Expand Down Expand Up @@ -190,20 +190,19 @@ vela show webservice

Check the configurable points (properties) of a trait
```shell
vela show ingress
vela show gateway
```

<details>
<summary>click to show properties of ingress trait</summary>
<summary>click to show properties of gateway trait</summary>

```console
# Properties
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
| http | Specify the mapping relationship between the http path and the workload port | map[string]int | true | |
| domain | Specify the domain you want to expose | string | true | |
+--------+------------------------------------------------------------------------------+----------------+----------+---------+
+---------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------+----------+------------------------+
| NAME | DESCRIPTION | TYPE | REQUIRED | DEFAULT |
+---------------------+------------------------------------------------------------------------------------------------------+-------------------------------------------------+----------+------------------------+
| domain | Specify the domain you want to expose. | string | false | |
| http | Specify the mapping relationship between the http path and the workload port. | map[string]int | true | |
```

</details>
Expand All @@ -222,23 +221,53 @@ spec:
- name: helloworld
type: webservice # <=== component type
properties: # <=== component properties
image: oamdev/helloworld-python:v1
image: <your_docker_username>/helloworld-python:v1
env:
- name: "TARGET"
value: "KubeVela"
port: 8080
traits:
- type: ingress # <=== trait type
- type: gateway # <=== trait type
properties: # <=== trait properties
domain: localhost
http:
/: 8080
```

Let's save it as file `app.yaml` and apply to deploy.
Update the above code with your docker username and save it as file `app.yaml`.
Use the Vela command to apply.

```shell script
vela up -f app.yaml --publish-version v1.1.0
```

You will get a success message as mentioned below.

```console
Applying an application in vela K8s object format...
✅ App has been deployed 🚀🚀🚀
Port forward: vela port-forward first-app -n prod
SSH: vela exec first-app -n prod
Logging: vela logs first-app -n prod
App status: vela status first-app -n prod
Endpoint: vela status first-app -n prod --endpoint
Application prod/first-app applied.
```

You can check the end point using the command

```shell script
kubectl apply -f app.yaml
vela status first-app --endpoint
```
The output would like the below

```console
+---------+------------+--------------------------+-----------------------------+-------+
| CLUSTER | COMPONENT | REF(KIND/NAMESPACE/NAME) | ENDPOINT | INNER |
+---------+------------+--------------------------+-----------------------------+-------+
| local | helloworld | Ingress/prod/helloworld | http://localhost | false |
| local | helloworld | Service/prod/helloworld | http://helloworld.prod:8080 | true |
+---------+------------+--------------------------+-----------------------------+-------+
```

## Verify
Expand All @@ -250,8 +279,8 @@ vela ls
```

```console
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
first-app helloworld webservice ingress running healthy 2021-05-18 15:40:02 +0900 KST
APP COMPONENT TYPE TRAITS PHASE HEALTHY STATUS CREATED-TIME
first-app helloworld webservice gateway running healthy Ready:1/1 2025-01-06 22:42:28 +0530 IST
```

And call the service by cURL tool
Expand All @@ -266,7 +295,6 @@ Hello KubeVela!

Yeah, we have successfully deploy an application from source now.

> :warning: ingress trait replies on the ingress controller, such as nginx-ingress, installed in your cluster.
> If you cannot access the domain, you may check the network or ingress
> configuration of your cluster.

Expand Down Expand Up @@ -299,9 +327,13 @@ if __name__ == "__main__":
Build and create image with a new tag.

```shell script
docker build -t oamdev/helloworld-python:v2 .
docker push oamdev/helloworld-python:v2
```
# Build the container on your local machine
docker_hub_username = <your_docker_username>
docker build -t $docker_hub_username/helloworld-python:v1 .

# Push the container to docker registry
docker push $docker_hub_username/helloworld-python:v1
```

### Change the component properties

Expand All @@ -323,7 +355,7 @@ spec:
value: "KubeVela"
port: 8080
traits:
- type: ingress
- type: gateway
properties:
domain: localhost
http:
Expand All @@ -332,8 +364,8 @@ spec:

Apply the upgraded application

```console
kubectl apply -f app-upgrade.yaml
```shell script
vela up -f app.yaml --publish-version v1.1.1
```

### Verify
Expand Down
7 changes: 4 additions & 3 deletions 01.Helloworld/app.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ spec:
- name: helloworld
type: webservice
properties:
image: oamdev/helloworld-python:v1
image: <your_docker_hub_username>/helloworld-python:v1
env:
- name: "TARGET"
value: "KubeVela"
port: 8080
traits:
- type: ingress
- type: gateway
properties:
domain: localhost
http:
/: 8080
- path: "/"
port: 8080
7 changes: 7 additions & 0 deletions 01.Helloworld/kind-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
extraMounts:
- hostPath: /Users/srajashekaran/Desktop/ZscalerRootCertificate-2048-SHA256.crt
containerPath: /etc/ssl/certs/zscaler.crt
2 changes: 1 addition & 1 deletion 02.ServiceTracker_App/KubeVelaManifest/app.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ spec:
- name: QUAKES_API_ROOT
value: "http://quakes-api.default.svc.cluster.local:3012/"
traits:
- type: ingress
- type: gateway
properties:
domain: localhost
http:
Expand Down
2 changes: 1 addition & 1 deletion 03.BikeSharing360_MultiContainer_App/KubeVelaManifest/app.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ spec:
- name: emailapi
value: "http://bikesharing-email-api"
traits:
- type: ingress
- type: gateway
properties:
domain: bikesharing.com
http:
Expand Down
4 changes: 0 additions & 4 deletions 03.BikeSharing360_MultiContainer_App/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,6 @@ BikeSharing 360 for single containers can be found
[installation](https://kubevela.io/docs/install) document to get KubeVela
installed.

* Make sure that the ingress controller has been installed (instructions
[here](https://kubernetes.github.io/ingress-nginx/deploy)).


## Quickstart: Deploy the sample through KubeVela

Deploy the application to Kubernetes cluster.
Expand Down