Skip to content

Commit 309ad10

Browse files
budifeast-ci-bot
authored andcommitted
update feast installation docs (#210)
* update feast installation docs - rename the feast service account - add notes on `--no-address` - make the important notes not greyed out * Update formatting
1 parent 330189d commit 309ad10

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

docs/install.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ GCP_SUBNETWORK=default
2626
GCP_DATAFLOW_MAX_NUM_WORKERS=4
2727

2828
FEAST_CLUSTER_NAME=feast
29-
FEAST_SERVICE_ACCOUNT_NAME=feast
29+
FEAST_SERVICE_ACCOUNT_NAME=feast-service-account
3030
FEAST_REDIS_GCE_INSTANCE_NAME=feast-redis
3131
# Set this to your preferred Postgres password.
3232
# Postgres is used to save Feast entity and feature specs and other configuration.
@@ -71,9 +71,6 @@ Run the following to create a virtual machine (VM) in Google Compute Engine (GCE
7171
> You can skip this step if you want to store Feast feature values for serving in an existing (non-clustered and non-authenticated) Redis instance.
7272
7373
```bash
74-
# Comment out "--no-address" option if you do not have a NAT router set up in your project
75-
# With no external ip, the VM instance requires a NAT router to access internet
76-
7774
gcloud --project=${GCP_PROJECT} compute instances create ${FEAST_REDIS_GCE_INSTANCE_NAME} \
7875
--zone=${GCP_ZONE} \
7976
--boot-disk-size=200GB \
@@ -82,10 +79,14 @@ gcloud --project=${GCP_PROJECT} compute instances create ${FEAST_REDIS_GCE_INSTA
8279
--network=${GCP_NETWORK} \
8380
--subnet=${GCP_SUBNETWORK} \
8481
--no-address \
85-
--metadata startup-script="apt-get -y install redis-server; echo 'bind 0.0.0.0' >> /etc/redis/redis.conf; sudo systemctl enable redis; sudo systemctl restart redis"
82+
--metadata startup-script="apt-get -y install redis-server; echo 'bind 0.0.0.0' >> /etc/redis/redis.conf; systemctl enable redis; systemctl restart redis"
8683
```
8784

85+
**NOTE**
86+
Comment out `--no-address` option if you do not have a NAT router set up in your project (especially in newly created Google Cloud Project). This will assign a public IP to the redis instance so it can access the internet without a NAT router. With no public IP, the instance requires a NAT router to access internet.
87+
8888
When the command above completes, it will output details of the newly created VM. Set the variable `FEAST_SERVING_REDIS_HOST` to the `INTERNAL_IP` value from the `gcloud` output.
89+
8990
```bash
9091
# Example output:
9192
# NAME ZONE MACHINE_TYPE INTERNAL_IP STATUS
@@ -162,10 +163,11 @@ Run the following command to create a helm values configuration file for Feast i
162163
> - `core.service.loadBalancerSourceRanges`
163164
> - `serving.service.annotations`
164165
> - `serving.service.loadBalancerSourceRanges`
165-
>
166-
> **IMPORTANT NOTE**
167-
> Commenting out those fields is **not** recommended, however, because it will **expose your Feast service to the public internet**.
168-
>
166+
167+
**IMPORTANT NOTE**
168+
169+
Commenting out those fields is **not** recommended, however, because it will **expose your Feast service to the public internet**.
170+
169171
> A better approach if you don't have VPN setup to your Google Cloud network is to create a new VM that will act as a [bastion host](https://en.wikipedia.org/wiki/Bastion_host). You will then access Feast services after SSH-ing to this bastion host (because you can then access Feast services via the internal load balancer IP).
170172
171173
```bash

0 commit comments

Comments
 (0)