Skip to content

Commit

Permalink
Aidan's comments
Browse files Browse the repository at this point in the history
  • Loading branch information
grahamia committed Jul 24, 2024
1 parent cca72b2 commit d25ab13
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 16 deletions.
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ test-argo:
$(MAKE) -C argo/kfp-compiler test
$(MAKE) -C argo/providers test

test-all: test helm-test test-argo
test-all: test helm-test-operator helm-test-provider test-argo

integration-test-all: integration-test
$(MAKE) -C argo/kfp-compiler integration-test
Expand Down Expand Up @@ -133,10 +133,10 @@ kustomize: ## Download kustomize locally if necessary.
$(call go-install,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected])

##@ Package
helm-package-operator: helm-cmd helm-test
helm-package-operator: helm-cmd helm-test-operator
$(HELM) package helm/kfp-operator --version $(VERSION) --app-version $(VERSION) -d dist

helm-package-provider: helm-cmd helm-provider-test
helm-package-provider: helm-cmd helm-test-provider
$(HELM) package helm/provider --version $(VERSION) --app-version $(VERSION) -d dist

helm-package: helm-package-operator helm-package-provider
Expand Down Expand Up @@ -187,7 +187,7 @@ endef
endif

INDEXED_YAML := $(YQ) e '{([.metadata.name, .kind] | join("-")): .}'
helm-test: manifests helm-cmd kustomize yq dyff
helm-test-operator: manifests helm-cmd kustomize yq dyff
$(eval TMP := $(shell mktemp -d))

# Create yaml files with helm and kustomize.
Expand All @@ -199,7 +199,7 @@ helm-test: manifests helm-cmd kustomize yq dyff
$(DYFF) between --set-exit-code $(TMP)/helm_indexed $(TMP)/kustomize_indexed
rm -rf $(TMP)

helm-provider-test: helm-cmd
helm-test-provider: helm-cmd
$(eval TMP := $(shell mktemp -d))
$(HELM) template helm/provider -f helm/provider/test/values.yaml > $(TMP)/helm

Expand Down
7 changes: 5 additions & 2 deletions docs-gen/content/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ This guide assumes you are familiar with [Helm](https://helm.sh/).

- [Argo 3.1.6-3.3](https://argoproj.github.io/argo-workflows/installation/) installed cluster-wide or into the namespace where the operator's workflows run (see [configuration](../../reference/configuration)).
- [Argo-Events 1.7.4+](https://argoproj.github.io/argo-events/installation/) installed cluster-wide (see [configuration](../../reference/configuration)).
- The KFP-Operator supports configurable provider backends. Currently, Kubeflow Pipelines and Vertex AI are supported. Please refer to the [respective configuration section](../../reference/configuration/#provider-configuration) before proceeding.

## KFP-Operator

Expand Down Expand Up @@ -74,7 +73,11 @@ Examples for these values can be found in the [test configuration]({{< ghblob "/

## Providers

Supported providers currently are Kubeflow Pipelines and Vertex AI. Install one or more by following these instructions.
Supported providers are:
- Kubeflow Pipelines
- Vertex AI

Install one or more by following these instructions. Please refer to the [respective configuration section](../../reference/configuration/#provider-configuration) before proceeding.

### Build and Install

Expand Down
8 changes: 6 additions & 2 deletions docs/docs/getting-started/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ A provider is a runtime environment for managing and executing ML pipelines and
&lt;ul>
&lt;li>&lt;a href="https://argoproj.github.io/argo-workflows/installation/">Argo 3.1.6-3.3&lt;/a> installed cluster-wide or into the namespace where the operator&amp;rsquo;s workflows run (see &lt;a href="../../reference/configuration">configuration&lt;/a>).&lt;/li>
&lt;li>&lt;a href="https://argoproj.github.io/argo-events/installation/">Argo-Events 1.7.4+&lt;/a> installed cluster-wide (see &lt;a href="../../reference/configuration">configuration&lt;/a>).&lt;/li>
&lt;li>The KFP-Operator supports configurable provider backends. Currently, Kubeflow Pipelines and Vertex AI are supported. Please refer to the &lt;a href="../../reference/configuration/#provider-configuration">respective configuration section&lt;/a> before proceeding.&lt;/li>
&lt;/ul>
&lt;h2 id="kfp-operator">KFP-Operator&lt;/h2>
&lt;p>To get a working installation you will need to install both the KFP-Operator and at least one provider (&lt;a href="#providers" title="Providers">see below&lt;/a>)&lt;/p>
Expand Down Expand Up @@ -210,7 +209,12 @@ A provider is a runtime environment for managing and executing ML pipelines and
&lt;p>Examples for these values can be found in the &lt;a href="https://github.com/sky-uk/kfp-operator/blob/master/helm/kfp-operator/test/values.yaml
">test configuration&lt;/a>&lt;/p>
&lt;h2 id="providers">Providers&lt;/h2>
&lt;p>Supported providers currently are Kubeflow Pipelines and Vertex AI. Install one or more by following these instructions.&lt;/p>
&lt;p>Supported providers are:&lt;/p>
&lt;ul>
&lt;li>Kubeflow Pipelines&lt;/li>
&lt;li>Vertex AI&lt;/li>
&lt;/ul>
&lt;p>Install one or more by following these instructions. Please refer to the &lt;a href="../../reference/configuration/#provider-configuration">respective configuration section&lt;/a> before proceeding.&lt;/p>
&lt;h3 id="build-and-install-1">Build and Install&lt;/h3>
&lt;p>Create basic &lt;code>kfp.yaml&lt;/code> value file with the following content:&lt;/p>
&lt;div class="highlight">&lt;pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;">&lt;code class="language-yaml" data-lang="yaml">&lt;span style="display:flex;">&lt;span>&lt;span style="color:#f92672">provider&lt;/span>:
Expand Down
Loading

0 comments on commit d25ab13

Please sign in to comment.