Skip to content

Commit f80d700

Browse files
philwinderphilwinder
authored
docs: better docs (#8)
* docs: better docs * terraform-docs: automated action Co-authored-by: philwinder <philwinder@users.noreply.github.com>
1 parent caf7c74 commit f80d700

File tree

3 files changed

+85
-40
lines changed

3 files changed

+85
-40
lines changed

‎.header.md

+40-19
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,52 @@
11
# terraform-k8s-feast
22

3-
Feast terraform module for combinator.ml
3+
**tl; dr;** A [combinator](https://combinator.ml) data component that installs [Feast](https://feast.dev), a feature store.
44

5-
## Usage
5+
- [Introduction](#introduction)
6+
- [Quick Drive](#quick-drive)
7+
* [Launch Jupyter](#launch-jupyter)
8+
* [Example Notebook](#example-notebook)
9+
- [Usage](#usage)
10+
* [Prerequisites](#prerequisites)
11+
* [Component Usage](#component-usage)
612

7-
```terraform
8-
module "feast" {
9-
source = "combinator-ml/feast/k8s"
10-
}
11-
```
13+
## Introduction
1214

13-
See the full configuration options below.
15+
[Feast](https://feast.dev) is an open-source feature store. A feature store allows you to manage, govern, and trace features derived from raw data. This is useful because it helps to unify and standardise, which reduces waste, improves quality, and makes models more reproducible.
1416

15-
### Stack Creation
17+
Feast does not perform any computation. You can think of it as a meta-database; a database that manages other databases. It effectively creates a cache of feature data, keyed by time. The Feast libraries and CLIs provide a consistent way of pushing or streaming new data into the cache. Downstream systems use a similar interface to access point-in-time data. [Learn more about feast in the documentation.](https://docs.feast.dev)
1618

17-
```bash
18-
KUBE_CONFIG_PATH=~/.kube/config terraform apply
19-
```
19+
## Test Drive
2020

21-
### Stack Deletion
21+
The fastest way to get started is to use the test drive functionality provided by [TestFaster](https://testfaster.ci). [Combinator](https://combinator.ml) website users can click the "Launch Test Drive" button below.
2222

23-
```bash
24-
KUBE_CONFIG_PATH=~/.kube/config terraform destroy
25-
```
23+
<!--<iframe width="600" height="400" id="testdrive" style="display: block;" src="https://testfaster.ci/launch?embedded=true&amp;repo=https://github.com/combinator-ml/terraform-k8s-feast&amp;file=examples/testfaster/.testfaster.yml"></iframe>-->
24+
25+
[:computer: Launch Test Drive :computer:](https://testfaster.ci/launch?embedded=true&amp;repo=https://github.com/combinator-ml/terraform-k8s-feast&amp;file=examples/testfaster/.testfaster.yml)
26+
27+
28+
29+
### Launch Jupyter
2630

27-
## Known Issues
31+
Once the component has launched, click on the Jupyter link. Feast does not have a UI by default. You will use Jupyter to interact with Feast via its API.
2832

29-
- Why do you have to explicitly export the Kubernetes config?
33+
### Example Notebook
3034

31-
I found that hardcoding the kubeconfig led to [this terraform bug](https://github.com/terraform-aws-modules/terraform-aws-eks/issues/1234).
35+
Once inside Jupyter, browse to the minimal notebook, which is the [official example](https://github.com/feast-dev/feast/tree/v0.9-branch/examples/minimal). Follow the instructions in the notebook.
36+
37+
## Usage
38+
39+
### Prerequisites
40+
41+
Start by preparing your Kubernetes cluster using one of the [infrastructure components](https://combinator.ml/infrastructure/introduction/) or use your own cluster.
42+
43+
### Component Usage
44+
45+
```terraform
46+
module "feast" {
47+
source = "combinator-ml/feast/k8s"
48+
# Optional settings go here
49+
}
50+
```
51+
52+
See the full configuration options below.

‎README.md

+38-19
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,53 @@
11
# terraform-k8s-feast
22

3-
Feast terraform module for combinator.ml
3+
**tl; dr;** A [combinator](https://combinator.ml) data component that installs [Feast](https://feast.dev), a feature store.
44

5-
## Usage
5+
- [Introduction](#introduction)
6+
- [Quick Drive](#quick-drive)
7+
* [Launch Jupyter](#launch-jupyter)
8+
* [Example Notebook](#example-notebook)
9+
- [Usage](#usage)
10+
* [Prerequisites](#prerequisites)
11+
* [Component Usage](#component-usage)
612

7-
```terraform
8-
module "feast" {
9-
source = "combinator-ml/feast/k8s"
10-
}
11-
```
13+
## Introduction
1214

13-
See the full configuration options below.
15+
[Feast](https://feast.dev) is an open-source feature store. A feature store allows you to manage, govern, and trace features derived from raw data. This is useful because it helps to unify and standardise, which reduces waste, improves quality, and makes models more reproducible.
1416

15-
### Stack Creation
17+
Feast does not perform any computation. You can think of it as a meta-database; a database that manages other databases. It effectively creates a cache of feature data, keyed by time. The Feast libraries and CLIs provide a consistent way of pushing or streaming new data into the cache. Downstream systems use a similar interface to access point-in-time data. [Learn more about feast in the documentation.](https://docs.feast.dev)
1618

17-
```bash
18-
KUBE_CONFIG_PATH=~/.kube/config terraform apply
19-
```
19+
## Test Drive
2020

21-
### Stack Deletion
21+
The fastest way to get started is to use the test drive functionality provided by [TestFaster](https://testfaster.ci). [Combinator](https://combinator.ml) website users can click the "Launch Test Drive" button below.
2222

23-
```bash
24-
KUBE_CONFIG_PATH=~/.kube/config terraform destroy
25-
```
23+
<!--<iframe width="600" height="400" id="testdrive" style="display: block;" src="https://testfaster.ci/launch?embedded=true&amp;repo=https://github.com/combinator-ml/terraform-k8s-feast&amp;file=examples/testfaster/.testfaster.yml"></iframe>-->
24+
25+
[:computer: Launch Test Drive :computer:](https://testfaster.ci/launch?embedded=true&amp;repo=https://github.com/combinator-ml/terraform-k8s-feast&amp;file=examples/testfaster/.testfaster.yml)
26+
27+
### Launch Jupyter
28+
29+
Once the component has launched, click on the Jupyter link. Feast does not have a UI by default. You will use Jupyter to interact with Feast via its API.
2630

27-
## Known Issues
31+
### Example Notebook
2832

29-
- Why do you have to explicitly export the Kubernetes config?
33+
Once inside Jupyter, browse to the minimal notebook, which is the [official example](https://github.com/feast-dev/feast/tree/v0.9-branch/examples/minimal). Follow the instructions in the notebook.
3034

31-
I found that hardcoding the kubeconfig led to [this terraform bug](https://github.com/terraform-aws-modules/terraform-aws-eks/issues/1234).
35+
## Usage
36+
37+
### Prerequisites
38+
39+
Start by preparing your Kubernetes cluster using one of the [infrastructure components](https://combinator.ml/infrastructure/introduction/) or use your own cluster.
40+
41+
### Component Usage
42+
43+
```terraform
44+
module "feast" {
45+
source = "combinator-ml/feast/k8s"
46+
# Optional settings go here
47+
}
48+
```
49+
50+
See the full configuration options below.
3251

3352
## Requirements
3453

‎.testfaster.yml ‎examples/testfaster/.testfaster.yml

+7-2
Original file line numberDiff line numberDiff line change
@@ -67,5 +67,10 @@ launch:
6767
- title: Jupyter
6868
port: 30600
6969
homepage: |
70-
## Follow the tutorial below
71-
Click the buttons above.
70+
### Launch Jupyter
71+
72+
Once the component has launched, click on the Jupyter link. Feast does not have a UI by default. You will use Jupyter to interact with Feast via its API.
73+
74+
### Example Notebook
75+
76+
Once inside Jupyter, browse to the minimal notebook, which is the [official example](https://github.com/feast-dev/feast/tree/v0.9-branch/examples/minimal). Follow the instructions in the notebook.

0 commit comments

Comments
 (0)