Skip to content

Commit 7469f0d

Browse files
author
Tyler Titsworth
authored
Add Chart Docs to Main README (#106)
Signed-off-by: Tyler Titsworth <tyler.titsworth@intel.com>
1 parent cb99be8 commit 7469f0d

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

+39-1
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
[![CodeQL](https://github.com/intel/ai-containers/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/github-code-scanning/codeql)
77
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/intel/ai-containers/main.svg)](https://results.pre-commit.ci/latest/github/intel/ai-containers/main)
88
[![Test Runner CI](https://github.com/intel/ai-containers/actions/workflows/test-runner-ci.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/test-runner-ci.yaml)
9-
[![Weekly Tests](https://github.com/intel/ai-containers/actions/workflows/weekly-test.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/weekly-test.yaml)
109
[![Helm Chart CI](https://github.com/intel/ai-containers/actions/workflows/chart-ci.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/chart-ci.yaml)
10+
[![Weekly Tests](https://github.com/intel/ai-containers/actions/workflows/weekly-test.yaml/badge.svg)](https://github.com/intel/ai-containers/actions/workflows/weekly-test.yaml)
1111

1212
This repository contains Dockerfiles, scripts, yaml files, Helm charts, etc. used to scale out AI containers with versions of TensorFlow and PyTorch that have been optimized for Intel platforms. Scaling is done with python, Docker, kubernetes, kubeflow, cnvrg.io, Helm, and other container orchestration frameworks for use in the cloud and on-premise.
1313

@@ -80,6 +80,44 @@ PACKAGE_OPTION=idp python test-runner/test_runner.py -f pytorch/tests/tests.yaml
8080
> [!TIP]
8181
> To test a container built by GitHub Actions CI/CD, find the `run number` associated with the workflow run and set the `GITHUB_RUN_NUMBER` environment variable during execution to pull the desired image.
8282
83+
## Deploy Containers
84+
85+
### Install [Helm](https://helm.sh/docs/intro/install/)
86+
87+
This assumes you've setup [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) and have a `KUBECONFIG`.
88+
89+
```bash
90+
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 && \
91+
chmod 700 get_helm.sh && \
92+
./get_helm.sh
93+
```
94+
95+
### Deploy a Helm Chart
96+
97+
```bash
98+
cd workflows/charts
99+
# Select a Chart and check its README for a list of customization options and other steps required.
100+
helm install <name> \
101+
--namespace=<namespace> \
102+
--set <key>=<value> \
103+
<chart-folder>
104+
```
105+
106+
### Test a Helm Chart
107+
108+
Install [Chart Testing](https://github.com/helm/chart-testing).
109+
110+
```bash
111+
pip install -r workflows/charts/dev-requirements.txt
112+
brew install chart-testing
113+
```
114+
115+
Utilize the `ct` CLI to run `helm lint`, `helm install`, and `helm test`.
116+
117+
```bash
118+
ct lint-and-install --namespace=<namespace> --config .github/ct.yaml --charts workflow/charts/<chart>
119+
```
120+
83121
## Troubleshooting
84122

85123
- See the [Docker Troubleshooting Article](https://docs.docker.com/engine/install/troubleshoot/).

0 commit comments

Comments
 (0)