Skip to content

Commit c95bb11

Browse files
author
Dilyan Marinov
committed
docs: add getting started section for quickstart-vdk and ui
What Add getting started section for quickstart-vdk and ui. Section gives an overview on how to get started with just vdk-core and quickstart-vdk. It's meant as a brief overview and links to more in-depth guides, e.g. wiki and videos Why README.md is the front page of the vdk project and it lacks a good getting started section. The current getting started section just links to the wiki. How was this tested n/a What kind of chenge is this docs
1 parent 4a51704 commit c95bb11

File tree

1 file changed

+43
-1
lines changed

1 file changed

+43
-1
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,53 @@ A preview of the VDK CLI commands:
102102

103103

104104
# Getting Started
105-
Installing VDK is a simple pip command. See the [Getting Started](https://github.com/vmware/versatile-data-kit/wiki/getting-started) guide to install VDK and create a data job.
105+
106+
## Create and run data jobs locally
107+
108+
```
109+
pip install quickstart-vdk
110+
```
111+
112+
This installs the core vdk packages and the vdk command line interface. You can
113+
use them to run jobs in your local shell environment.
114+
115+
See also the [Getting
116+
Started](https://github.com/vmware/versatile-data-kit/wiki/getting-started)
117+
section of the wiki
118+
119+
## Deploy and manage jobs in Kubernetes cloud
120+
121+
Using Kubernetes for your data jobs workflow provides additional benefits, such
122+
as continuous delivery, easier collaboration, streamlined data job
123+
orchestration, high availability, security, and job runtime isolation
124+
125+
More info https://kubernetes.io/docs/concepts/overview/
126+
127+
**Prerequisites**
128+
- [helm](https://helm.sh/docs/intro/install)
129+
- [docker](https://docs.docker.com/get-docker)
130+
- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) (version 0.11.1 or later)
131+
132+
```
133+
vdk server --install
134+
```
135+
136+
The server includes:
137+
- control service - provides an API for managing the lifecycle of Data Jobs and
138+
an execution environment where jobs can be deployed
139+
- operations ui - the vdk user interface
140+
- git server - stores data job source code
141+
- docker registry - stores data job images
142+
143+
You can then use the vdk cli to create and deploy jobs and the UI to manage
144+
them.
106145

107146
# Next Steps
108147
- See [use case examples](https://github.com/vmware/versatile-data-kit/wiki/Examples) that show how VDK fits into the data workflow.
109148
- See the [documentation](https://github.com/vmware/versatile-data-kit/wiki/Introduction) for VDK.
149+
- [Getting started with VDK Operations UI](https://www.youtube.com/watch?v=DLRGCCGUp0U)
150+
- [VDK Operations UI Overview](https://www.youtube.com/watch?v=9BkAOSvXuUg)
151+
- [Running in production](https://github.com/vmware/versatile-data-kit/wiki/Installation#install-versatile-data-kit-control-service)
110152
- Read the article about [using the Versatile Data Kit and Trino DB](https://towardsdatascience.com/from-raw-data-to-a-cleaned-database-a-deep-dive-into-versatile-data-kit-ab5fd992a02e).
111153
- Join us at a [community meeting](https://github.com/vmware/versatile-data-kit/wiki/Community-and-Resources)
112154

0 commit comments

Comments
 (0)