mirrors/kube-arangodb
1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-14 11:57:37 +00:00
Code Activity

Update Documentation for Release

Browse source
This commit is contained in:
ajanikow 2024-05-24 08:07:54 +00:00
parent 566a3b130a
commit edb09bbfc5
No known key found for this signature in database
GPG key ID: BD072E1332E4C605
3 changed files with 20 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -1,6 +1,8 @@
# Change Log # Change Log
## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A) ## [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 - (Maintenance) Bump Prometheus API Version
- (Bugfix) Prevent unexpected rotation in case of SecurityContext change - (Bugfix) Prevent unexpected rotation in case of SecurityContext change
- (Bugfix) Ensure PDB is created - (Bugfix) Ensure PDB is created

12
docs/gae-resource.md Normal file
View file

@ -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)

17
docs/mlextension-resource.md
View file

@ -9,7 +9,7 @@ title: ArangoMLExtension
#### Enterprise Edition only #### 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. 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 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: - Create ArangoMLStorage resource. Example:
```yaml ```yaml
apiVersion: ml.arangodb.com/v1alpha1 apiVersion: ml.arangodb.com/v1beta1
kind: ArangoMLStorage kind: ArangoMLStorage
metadata: metadata:
name: myarangoml-storage 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. 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: Assuming you have ArangoDeployment with name `myarangodb`, create CR:
```yaml ```yaml
apiVersion: ml.arangodb.com/v1alpha1 apiVersion: ml.arangodb.com/v1beta1
kind: ArangoMLExtension kind: ArangoMLExtension
metadata: metadata:
name: myarangodb name: myarangodb
@ -59,15 +59,8 @@ 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 name: myarangoml-storage # name of the ArangoMLStorage created on the previous step
deployment: deployment:
# you can add here: tolerations, nodeSelector, nodeAffinity, scheduler and many other parameters. See full CRD reference for details. # 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. replicas: 1 # by default only one pod is running which contains containers for api. You can scale it up or down.
prediction: image: <api-image>
image: <prediction-image>
# you can configure various parameters for container running this component here. See full CRD reference for details.
project:
image: <projects-image>
# you can configure various parameters for container running this component here. See full CRD reference for details.
training:
image: <training-image>
# you can configure various parameters for container running this component here. See full CRD reference for details. # 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. init: # configuration for Kubernetes Job running initial bootstrap of ArangoML for your cluster.
image: <init-image> image: <init-image>