knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Format markdown (#650) 

Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)`
This commit is contained in:
mattmoor-sockpuppet 2018-12-10 12:50:15 -08:00 committed by Knative Prow Robot
parent 8184d7a72e
commit 4f0ffb8d31
4 changed files with 137 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
serving/outbound-network-access.md
View File

@ -25,8 +25,7 @@ The scope varies depending on your platform:
- For IBM Cloud Kubernetes Service use
`172.30.0.0/16,172.20.0.0/16,10.10.10.0/24`
- For Azure Container Service (ACS) use `10.244.0.0/16,10.240.0.0/16`
- For Pivotal Container Service (PKS) on GCP use
`10.200.0.0/16,10.100.200.0/24`
- For Pivotal Container Service (PKS) on GCP use `10.200.0.0/16,10.100.200.0/24`
- For Minikube use `10.0.0.1/24`
## Setting the IP scope

1
serving/samples/autoscale-go/README.md
View File

@ -21,7 +21,6 @@ A demonstration of the autoscaling capabilities of a Knative Serving Revision.
## Deploy the Service
1. Deploy the [sample](./service.yaml) Knative Service:
```

82
serving/using-external-dns-on-gcp.md
View File

@ -10,6 +10,7 @@ publishing the Knative domain.
## Set up environtment variables
Run the following command to configure the environment variables
```shell
export PROJECT_NAME=<your-google-cloud-project-name>
@ -29,6 +30,7 @@ read/write permissions.
You can create a GKE cluster with Cloud DNS scope by entering the following
command:
```shell
gcloud container clusters create $CLUSTER_NAME \
--zone=$CLUSTER_ZONE \
@ -39,11 +41,15 @@ gcloud container clusters create $CLUSTER_NAME \
--scopes=service-control,service-management,compute-rw,storage-ro,cloud-platform,logging-write,monitoring-write,pubsub,datastore,"https://www.googleapis.com/auth/ndev.clouddns.readwrite" \
--num-nodes=3
```
Note that by using this way, any pod within the cluster will have permissions to read/write CloudDNS.
Note that by using this way, any pod within the cluster will have permissions to
read/write CloudDNS.
### Cluster with Cloud DNS Admin Service Account credential
1. Create a GKE cluster without Cloud DNS scope by entering the following command:
1. Create a GKE cluster without Cloud DNS scope by entering the following
command:
```shell
gcloud container clusters create $CLUSTER_NAME \
--zone=$CLUSTER_ZONE \
@ -56,6 +62,7 @@ gcloud container clusters create $CLUSTER_NAME \
```
2. Create a new service account for Cloud DNS admin role.
```shell
# Name of the service account you want to create.
export CLOUD_DNS_SA=cloud-dns-admin
@ -66,6 +73,7 @@ gcloud --project $PROJECT_NAME iam service-accounts \
```
3. Bind the role `dns.admin` to the newly created service account.
```shell
# Fully-qualified service account name also has project-id information.
export CLOUD_DNS_SA=$CLOUD_DNS_SA@$PROJECT_NAME.iam.gserviceaccount.com
@ -76,38 +84,45 @@ gcloud projects add-iam-policy-binding $PROJECT_NAME \
```
4. Download the secret key file for your service account.
```shell
gcloud iam service-accounts keys create ~/key.json \
--iam-account=$CLOUD_DNS_SA
```
5. Upload the service account credential to your cluster.
This command uses the secret name `cloud-dns-key`, but you can
choose a different name.
5. Upload the service account credential to your cluster. This command uses the
secret name `cloud-dns-key`, but you can choose a different name.
```shell
kubectl create secret generic cloud-dns-key \
--from-file=key.json=$HOME/key.json
```
6. Delete the local secret
```shell
rm ~/key.json
```
Now your cluster has the credential of your CloudDNS admin service account.
And it can be used to access your Cloud DNS. You can enforce the access of the
Now your cluster has the credential of your CloudDNS admin service account. And
it can be used to access your Cloud DNS. You can enforce the access of the
credentail secret within your cluster, so that only the pods that have the
permission to get the credential secret can access your Cloud DNS.
## Set up Knative
1. Follow the [instruction](https://github.com/knative/docs/blob/master/install/README.md) to install Knative on your cluster.
1. Follow the
[instruction](https://github.com/knative/docs/blob/master/install/README.md)
to install Knative on your cluster.
1. Configure Knative to use your custom domain.
```shell
kubectl edit cm config-domain --namespace knative-serving
```
This command opens your default text editor and allows you to edit the config
map.
```
apiVersion: v1
data:
@ -115,9 +130,11 @@ data:
kind: ConfigMap
[...]
```
Edit the file to replace `example.com` with your custom domain (the
value of `$CUSTOM_DOMAIN`) and save your changes. In this example, we use domain `external-dns-test.my-org.do`
for all routes:
Edit the file to replace `example.com` with your custom domain (the value of
`$CUSTOM_DOMAIN`) and save your changes. In this example, we use domain
`external-dns-test.my-org.do` for all routes:
```
apiVersion: v1
data:
@ -141,6 +158,7 @@ A DNS zone which will contain the managed DNS records needs to be created.
Use the following command to create a DNS zone with
[Google Cloud DNS](https://cloud.google.com/dns/):
```shell
export DNS_ZONE_NAME=<dns-zone-name>
@ -148,27 +166,33 @@ gcloud dns managed-zones create $DNS_ZONE_NAME \
--dns-name $CUSTOM_DOMAIN \
--description "Automatically managed zone by kubernetes.io/external-dns"
```
Make a note of the nameservers that were assigned to your new zone.
```shell
gcloud dns record-sets list \
--zone $DNS_ZONE_NAME \
--name $CUSTOM_DOMAIN \
--type NS
```
You should see output similar to the following assuming your custom domain is
`external-dns-test.my-org.do`:
```
NAME TYPE TTL DATA
external-dns-test.my-org.do. NS 21600 ns-cloud-e1.googledomains.com.,ns-cloud-e2.googledomains.com.,ns-cloud-e3.googledomains.com.,ns-cloud-e4.googledomains.com.
```
In this case, the DNS nameservers are `ns-cloud-{e1-e4}.googledomains.com`.
Yours could differ slightly, e.g. {a1-a4}, {b1-b4} etc.
If this zone has the parent zone, you need to add NS records of this zone into
the parent zone so that this zone can be found from the parent. Assuming the
parent zone is `my-org-do` and the parent domain is `my-org.do`, and the
parent zone is also hosted at Google Cloud DNS, you can follow these steps to
add the NS records of this zone into the parent zone:
parent zone is `my-org-do` and the parent domain is `my-org.do`, and the parent
zone is also hosted at Google Cloud DNS, you can follow these steps to add the
NS records of this zone into the parent zone:
```shell
gcloud dns record-sets transaction start --zone "my-org-do"
gcloud dns record-sets transaction add ns-cloud-e{1..4}.googledomains.com. \
@ -180,7 +204,9 @@ gcloud dns record-sets transaction execute --zone "my-org-do"
Firstly, choose the manifest of ExternalDNS.
Use below manifest if you set up your cluster with [CloudDNS scope](#cluster-with-cloud-dns-scope).
Use below manifest if you set up your cluster with
[CloudDNS scope](#cluster-with-cloud-dns-scope).
```yaml
apiVersion: v1
kind: ServiceAccount
@ -244,7 +270,9 @@ spec:
- --txt-owner-id=my-identifier
```
Or use below manifest if you set up your cluster with [CloudDNS service account credential](#cluster-with-cloud-dns-admin-service-account-credential).
Or use below manifest if you set up your cluster with
[CloudDNS service account credential](#cluster-with-cloud-dns-admin-service-account-credential).
```yaml
apiVersion: v1
kind: ServiceAccount
@ -320,6 +348,7 @@ spec:
Then use the following command to apply the manifest you chose to install
ExternalDNS
```shell
cat <<EOF | kubectl apply --filename -
<your-chosen-manifest>
@ -327,6 +356,7 @@ EOF
```
You should see ExternalDNS is installed by running:
```shell
kubectl get deployment external-dns
```
@ -334,15 +364,18 @@ kubectl get deployment external-dns
### Configuring Knative Gateway service
In order to publish the Knative Gateway service, the annotation
`external-dns.alpha.kubernetes.io/hostname: '*.$CUSTOM_DOMAIN`
needs to be added into Knative gateway service:
`external-dns.alpha.kubernetes.io/hostname: '*.$CUSTOM_DOMAIN` needs to be added
into Knative gateway service:
```shell
kubectl edit svc knative-ingressgateway --namespace istio-system
```
This command opens your default text editor and allows you to add the
annotation to `knative-ingressgateway` service. After you've added your
annotation, your file may look similar to this (assuming your custom domain is
This command opens your default text editor and allows you to add the annotation
to `knative-ingressgateway` service. After you've added your annotation, your
file may look similar to this (assuming your custom domain is
`external-dns-test.my-org.do`):
```
apiVersion: v1
kind: Service
@ -360,6 +393,7 @@ service was created.
```shell
gcloud dns record-sets list --zone $DNS_ZONE_NAME --name "*.$CUSTOM_DOMAIN."
```
You should see output similar to:
```
@ -372,12 +406,16 @@ NAME TYPE TTL DATA
You can check if the domain has been published to the Internet be entering the
following command:
```shell
host test.external-dns-test.my-org.do
```
You should see the below result after the domain is published:
```
test.external-dns-test.my-org.do has address 35.231.248.30
```
> Note: The process of publishing the domain to the Internet can take several
minutes.
> minutes.