Skip to content

Add MongoDB external connections(horizons) Docs #769

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/examples/mongodb/horizons/binding.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
apiVersion: catalog.appscode.com/v1alpha1
kind: MongoDBBinding
metadata:
name: mongodb-bind
namespace: demo
spec:
sourceRef:
name: mongodb-horizons
namespace: demo
46 changes: 46 additions & 0 deletions docs/examples/mongodb/horizons/envoyproxy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
apiVersion: gateway.envoyproxy.io/v1alpha1
kind: EnvoyProxy
metadata:
name: ace
namespace: ace-gw
spec:
logging:
level:
default: warn
mergeGateways: true
provider:
kubernetes:
envoyDeployment:
container:
image: ghcr.io/voyagermesh/envoy:v1.33.1-ac
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
privileged: false
runAsNonRoot: true
runAsUser: 65534
seccompProfile:
type: RuntimeDefault
patch:
value:
spec:
template:
spec:
containers:
- name: shutdown-manager
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
privileged: false
runAsNonRoot: true
runAsUser: 65534
seccompProfile:
type: RuntimeDefault
envoyService:
externalTrafficPolicy: Cluster
type: NodePort
type: Kubernetes
27 changes: 27 additions & 0 deletions docs/examples/mongodb/horizons/gatewayclass.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
apiVersion: gateway.networking.k8s.io/v1
kind: GatewayClass
metadata:
annotations:
catalog.appscode.com/gateway-config: |-
frontendTLSSecretRef:
name: ace-gw-cert
namespace: ace
service:
externalTrafficPolicy: Cluster
nodeportRange: 30000-32767
portRange: 10000-12767
seedBackendPort: 8080
type: LoadBalancer
vaultServer:
name: vault
namespace: ace
catalog.appscode.com/is-default-gatewayclass: "true"
name: ace
spec:
controllerName: gateway.envoyproxy.io/gatewayclass-controller
description: Default Service GatewayClass
parametersRef:
group: gateway.envoyproxy.io
kind: EnvoyProxy
name: ace
namespace: ace-gw
11 changes: 11 additions & 0 deletions docs/examples/mongodb/horizons/helmrepo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: source.toolkit.fluxcd.io/v1
kind: HelmRepository
metadata:
name: appscode-charts-oci
namespace: kubeops
spec:
interval: 30m
provider: generic
timeout: 1m
type: oci
url: oci://ghcr.io/appscode-charts
90 changes: 90 additions & 0 deletions docs/examples/mongodb/horizons/keda.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
name: keda
namespace: kubeops
spec:
chart:
spec:
chart: keda
reconcileStrategy: ChartVersion
sourceRef:
kind: HelmRepository
name: appscode-charts-oci
namespace: kubeops
version: 2.16.1
install:
crds: CreateReplace
createNamespace: true
remediation:
retries: -1
interval: 5m
releaseName: keda
storageNamespace: keda
targetNamespace: keda
timeout: 30m
upgrade:
crds: CreateReplace
remediation:
retries: -1
values:
image:
keda:
registry: ghcr.io
metricsApiServer:
registry: ghcr.io
webhooks:
registry: ghcr.io
---
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
name: keda-add-ons-http
namespace: kubeops
spec:
chart:
spec:
chart: keda-add-ons-http
reconcileStrategy: ChartVersion
sourceRef:
kind: HelmRepository
name: appscode-charts-oci
namespace: kubeops
version: 0.10.0
dependsOn:
- name: keda
install:
crds: CreateReplace
createNamespace: true
remediation:
retries: -1
interval: 5m
releaseName: keda-add-ons-http
storageNamespace: keda
targetNamespace: keda
timeout: 30m
upgrade:
crds: CreateReplace
remediation:
retries: -1
values:
images:
interceptor: ghcr.io/kedacore/http-add-on-interceptor
kubeRbacProxy:
name: ghcr.io/appscode/kube-rbac-proxy
operator: ghcr.io/kedacore/http-add-on-operator
scaler: ghcr.io/kedacore/http-add-on-scaler
interceptor:
responseHeaderTimeout: 1s
securityContext:
allowPrivilegeEscalation: false
capabilities:
drop:
- ALL
privileged: false
readOnlyRootFilesystem: true
runAsGroup: 1000
runAsNonRoot: true
runAsUser: 1000
seccompProfile:
type: RuntimeDefault
39 changes: 39 additions & 0 deletions docs/examples/mongodb/horizons/mongodb.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
apiVersion: kubedb.com/v1
kind: MongoDB
metadata:
name: mongodb-horizons
namespace: demo
spec:
clusterAuthMode: x509
deletionPolicy: WipeOut
replicaSet:
horizons:
dns: kubedb.cloud
pods:
- mongo-0.kubedb.cloud
- mongo-1.kubedb.cloud
- mongo-2.kubedb.cloud
name: rs0
replicas: 3
sslMode: requireSSL
storage:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 2Gi
storageEngine: wiredTiger
storageType: Durable
tls:
certificates:
- alias: server
dnsNames:
- kubedb.cloud
- mongo-0.kubedb.cloud
- mongo-1.kubedb.cloud
- mongo-2.kubedb.cloud
issuerRef:
apiGroup: cert-manager.io
kind: Issuer
name: mongo-ca-issuer
version: 7.0.16
12 changes: 11 additions & 1 deletion docs/guides/mongodb/concepts/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ spec:
externallyManaged: false
replicaSet:
name: rs0
horizons:
dns: kubedb.cloud
pods:
- mongo-0.kubedb.cloud
- mongo-1.kubedb.cloud
- mongo-2.kubedb.cloud
shardTopology:
configServer:
podTemplate: {}
Expand Down Expand Up @@ -251,7 +257,11 @@ Secrets provided by users are not managed by KubeDB, and therefore, won't be mod

### spec.replicaSet

`spec.replicaSet` represents the configuration for replicaset. When `spec.replicaSet` is set, KubeDB will deploy a mongodb replicaset where number of replicaset member is spec.replicas.
`spec.replicaSet` represents the configuration for replicaset. When `spec.replicaSet` is set, KubeDB will deploy a mongodb replicaset where number of replicaset member is `spec.replicas`.

`.spec.replicaset.horizons` represents the configuration for mongodb replicaset to connect with external mongodb cluster. It has the following fields:
- `dns` denotes the dns name for `srv` of the external mongodb cluster.
- `pods` denotes the list of pods of external mongodb cluster.

- `name` denotes the name of mongodb replicaset.
NB. If `spec.shardTopology` is set, then `spec.replicaset` needs to be empty.
Expand Down
10 changes: 10 additions & 0 deletions docs/guides/mongodb/external-connections/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: External MongoDB Connections Outside Kubernetes using MongoDB HorizonsRun
menu:
docs_{{ .version }}:
identifier: mg-horizons
name: External Connections(Horizons)
parent: mg-mongodb-guides
weight: 31
menu_name: docs_{{ .version }}
---
Loading
Loading