generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 465
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
write a very simple getting started guide
- Loading branch information
Showing
17 changed files
with
923 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
# Getting started with Services APIs | ||
|
||
## Installing CRDs | ||
|
||
This project provides a collection of Custom Resource Definitions (CRDs)that can | ||
be installed into any Kubernetes (>= 1.16) cluster. | ||
|
||
To install the CRDs, please execute: | ||
|
||
``` | ||
kubectl kustomize "github.com/kubernetes-sigs/service-apis/config/crd?ref=master" \ | ||
| kubectl apply -f - | ||
``` | ||
|
||
## Install an implementation | ||
|
||
Multiple projects implement the APIs defined by this project. | ||
You will need to either install an implementation or verify if one is already | ||
setup for your cluster. | ||
|
||
## Sample Gateway | ||
|
||
Once you have the CRDs and an implementation installed, you are ready to | ||
use Service APIs. | ||
|
||
In this example, we are installing three resources: | ||
|
||
- An `acme-lb` GatewayClass which is being managed by a `acme.io/gateway-controller` | ||
controller running in the cluster. | ||
- A Gateway which is of type `acme-lb`: | ||
- This gateway has a single HTTP listener on port 80 which selects HTTPRoutes | ||
from all namespaces which have the label `app: foo` on them. | ||
|
||
- Finally, we have an HTTPRoute resource which is attached to the above Gateway | ||
and has two rules: | ||
- All requests with path beginning with `/bar` are forwarded to my-service1 | ||
Kubernetes Service. | ||
- All requests with path beginning with `/some/thing` AND have an HTTP header | ||
`magic: foo` are forwarded to my-service2 Kubernetes Service. | ||
|
||
With this configuration, you now have a Gateway reource which is forwarding | ||
traffic to two Kubernetes Services based on HTTP request metadata. | ||
|
||
``` | ||
{% include 'basic-http.yaml' %} | ||
``` | ||
|
||
For more advanced examples, please checkout other [guides](guides.md). | ||
|
||
## Uninstalling the CRDs | ||
|
||
``` | ||
kubectl kustomize "github.com/kubernetes-sigs/service-apis/config/crd?ref=master" \ | ||
| kubectl delete -f - | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.