From edb09bbfc535a4f8bf4172f8b7e4b92fe2b2dc92 Mon Sep 17 00:00:00 2001 From: ajanikow <12255597+ajanikow@users.noreply.github.com> Date: Fri, 24 May 2024 08:07:54 +0000 Subject: [PATCH] Update Documentation for Release --- CHANGELOG.md | 2 ++ docs/gae-resource.md | 12 ++++++++++++ docs/mlextension-resource.md | 19 ++++++------------- 3 files changed, 20 insertions(+), 13 deletions(-) create mode 100644 docs/gae-resource.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 8bdb106ee..59f95a18a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log ## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A) + +## [1.2.41](https://github.com/arangodb/kube-arangodb/tree/1.2.41) (2024-05-24) - (Maintenance) Bump Prometheus API Version - (Bugfix) Prevent unexpected rotation in case of SecurityContext change - (Bugfix) Ensure PDB is created diff --git a/docs/gae-resource.md b/docs/gae-resource.md new file mode 100644 index 000000000..124d9fe6b --- /dev/null +++ b/docs/gae-resource.md @@ -0,0 +1,12 @@ +--- +layout: page +parent: Custom resources overview +title: GraphAnalyticsEngine +--- + +# GraphAnalyticsEngine Custom Resource + + +#### Enterprise Edition only + +[Full CustomResourceDefinition reference ->](./api/GraphAnalyticsEngine.V1Alpha1.md) diff --git a/docs/mlextension-resource.md b/docs/mlextension-resource.md index 55c6c3677..cc3667195 100644 --- a/docs/mlextension-resource.md +++ b/docs/mlextension-resource.md @@ -9,7 +9,7 @@ title: ArangoMLExtension #### Enterprise Edition only -[Full CustomResourceDefinition reference ->](./api/ArangoMLExtension.V1Alpha1.md) +[Full CustomResourceDefinition reference ->](./api/ArangoMLExtension.v1beta1.md) You can spin up the [ArangoML](https://github.com/arangoml) engine on existing ArangoDeployment. @@ -29,7 +29,7 @@ If you don't have one yet, consider checking [kube-arangodb installation guide]( - Create Kubernetes Secret containing CA certificates to validate connection to endpoint if your Minio installation uses encrypted connection. The secret data should contain two fields: `ca.crt` and `ca.key` (both PEM-encoded). - Create ArangoMLStorage resource. Example: ```yaml - apiVersion: ml.arangodb.com/v1alpha1 + apiVersion: ml.arangodb.com/v1beta1 kind: ArangoMLStorage metadata: name: myarangoml-storage @@ -50,7 +50,7 @@ If you don't have one yet, consider checking [kube-arangodb installation guide]( 3) Create `ArangoMLExtension` CR. The name of extension **must** be the same as the name of `ArangoDeployment` and it should be created in the same namespace. Assuming you have ArangoDeployment with name `myarangodb`, create CR: ```yaml - apiVersion: ml.arangodb.com/v1alpha1 + apiVersion: ml.arangodb.com/v1beta1 kind: ArangoMLExtension metadata: name: myarangodb @@ -59,16 +59,9 @@ If you don't have one yet, consider checking [kube-arangodb installation guide]( name: myarangoml-storage # name of the ArangoMLStorage created on the previous step deployment: # you can add here: tolerations, nodeSelector, nodeAffinity, scheduler and many other parameters. See full CRD reference for details. - replicas: 1 # by default only one pod is running which contains containers for each component (prediction, training, project). You can scale it up or down. - prediction: - image: - # you can configure various parameters for container running this component here. See full CRD reference for details. - project: - image: - # you can configure various parameters for container running this component here. See full CRD reference for details. - training: - image: - # you can configure various parameters for container running this component here. See full CRD reference for details. + replicas: 1 # by default only one pod is running which contains containers for api. You can scale it up or down. + image: + # you can configure various parameters for container running this component here. See full CRD reference for details. init: # configuration for Kubernetes Job running initial bootstrap of ArangoML for your cluster. image: # you can add here: tolerations, nodeSelector, nodeAffinity, scheduler and many other parameters. See full CRD reference for details.