Skip to content

Commit da74668

Browse files
Merge pull request #9799 from mendix/kk-pc-k8s-minikube
Minikube clarifications
2 parents d469ed0 + 62a7cc0 commit da74668

10 files changed

Lines changed: 23 additions & 17 deletions

File tree

content/en/docs/deployment/docker-deploy/run-mendix-on-kubernetes.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,32 @@
11
---
22
title: "Use Docker with Minikube"
33
linktitle: "Run with Minikube"
4-
url: /developerportal/deploy/run-mendix-on-kubernetes/
4+
url: /developerportal/deploy/run-mendix-on-minikube/
55
weight: 20
6+
aliases:
7+
- /developerportal/deploy/run-mendix-on-kubernetes/
68
---
79

810
## Introduction
911

12+
{{% alert color="info" %}}
13+
This document is about local deployments on [Minikube](https://kubernetes.io/docs/getting-started-guides/minikube/). For the Mendix on Kubernetes solution, see [Mendix on Kubernetes](/developerportal/deploy/private-cloud/).
14+
{{% /alert %}}
15+
1016
This how-to takes you through the process of deploying a Docker image of your Mendix app to [Minikube](https://kubernetes.io/docs/getting-started-guides/minikube/), a local version of [Kubernetes](https://kubernetes.io/docs/home/) which runs in a Windows container or virtual machine. Many of the operations you perform on Minikube are the same as those on a hosted environment and it provides a low-level entry to Kubernetes. For more information, see [Installing Kubernetes with Minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/) on the Kubernetes documentation site.
1117

12-
Kubernetes is a standard container orchestration platform supported by Mendix. For details on supported version of Kubernetes see [Mendix System Requirements](/refguide/system-requirements/). When publishing to your cloud infrastructure, Mendix suggests you use [Mendix on Kubernetes](/developerportal/deploy/private-cloud/) to deploy Mendix apps to Kubernetes as this provides you with integration with the Mendix Portal and takes away much of the heavy lifting.
18+
Kubernetes is a standard container orchestration platform supported by Mendix. For details on supported version of Kubernetes see [Mendix System Requirements](/refguide/system-requirements/).
19+
20+
{{% alert color="info" %}}
21+
Deploying a Docker image on Minikube is intended for test projects on a local machine. When publishing to your cloud infrastructure, Mendix suggests you use the [Mendix on Kubernetes](/developerportal/deploy/private-cloud/) solution, as this provides you with integration with the Mendix Portal and takes away much of the heavy lifting.
22+
{{% /alert %}}
1323

1424
This how-to teaches you how to do the following:
1525

16-
* Deploy and run a Mendix app on Kubernetes using Minikube
26+
* Deploy and run a Mendix app using Minikube
1727
* Separate the database deployment from your app
1828
* Attach persistence storage to the app container
1929

20-
{{% alert color="warning" %}}
21-
Do not use these instructions if you are using Mendix on Kubernetes — Mendix on Kubernetes performs many of the steps here for you. If deploying using Mendix on Kubernetes, follow the instructions in the [Mendix on Kubernetes](/developerportal/deploy/private-cloud/) documentation.
22-
{{% /alert %}}
23-
2430
## Prerequisites
2531

2632
To follow this how-to, you should have a basic knowledge of Docker and Kubernetes. For more information, see [Docker Overview](https://docs.docker.com/engine/docker-overview/) and [Kubernetes Basics](https://kubernetes.io/docs/tutorials/kubernetes-basics/). Although you do not need more knowledge to execute all the commands provided, some experience will help you to understand the how-to better.
@@ -37,7 +43,7 @@ This how-to uses commands for a Unix-like system. The commands for Windows may b
3743

3844
## Architecture Overview{#architecture}
3945

40-
Before you start, here is some background information on the components needed to deploy a Mendix app on Kubernetes.
46+
Before you start, here is some background information on the components needed to deploy a Mendix app with Minikube.
4147

4248
A Mendix application needs, as a minimum, a database to run. In this example you provision a PostgreSQL database within the Kubernetes cluster. In production scenarios, the database is usually provided as a service by the cloud provider, like AWS RDS or Azure SQL. For supported databases see [Mendix System Requirements](/refguide/system-requirements/).
4349

content/en/docs/deployment/general/licensing-apps-outside-mxcloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ To activate a license on your app running on Kubernetes, you need the license cr
121121

122122
Two additional environment variables, `LICENSE_ID` and `LICENSE_KEY`, need to be set to the values of the **LicenseId** and **LicenseKey** provided by Mendix Support. To do this, add them to the deployment command for your app.
123123

124-
For full instructions on how to do this and how to supply the keys using a **Secrets** file, see the [Deploying the Application](/developerportal/deploy/run-mendix-on-kubernetes/#deploy) section of *Use Docker with Minikube*.
124+
For full instructions on how to do this and how to supply the keys using a **Secrets** file, see the [Deploying the Application](/developerportal/deploy/run-mendix-on-minikube/#deploy) section of *Use Docker with Minikube*.
125125

126126
### Windows Server
127127

content/en/docs/refguide/installation/system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ For container-based deployments using Docker, Kubernetes, or Cloud Foundry, the
244244
* SAP AWS S3 Object Storage
245245
* SAP Azure Blob Storage
246246

247-
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-kubernetes/).
247+
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-minikube/).
248248

249249
### Storage Types for Servers
250250

content/en/docs/refguide/runtime/clustered-mendix-runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The main feature enabling clustering is Mendix's stateless runtime architecture.
1515

1616
Clustering support is built natively into our Cloud Foundry buildpack implementation. This means that you can simply scale up using Cloud Foundry. The buildpack ensures that your system automatically starts behaving as a cluster.
1717

18-
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-kubernetes/#scaling) section of *Use Docker with Minikube*.
18+
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-minikube/#scaling) section of *Use Docker with Minikube*.
1919

2020
## Cluster Infrastructure
2121

content/en/docs/refguide10/installation/system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ For container-based deployments using Docker, Kubernetes, or Cloud Foundry, the
268268
* SAP AWS S3 Object Storage
269269
* SAP Azure Blob Storage
270270

271-
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-kubernetes/).
271+
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-minikube/).
272272

273273
### Storage Types for Servers
274274

content/en/docs/refguide10/runtime/clustered-mendix-runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The main feature enabling clustering is Mendix's stateless runtime architecture.
1515

1616
Clustering support is built natively into our Cloud Foundry buildpack implementation. This means that you can simply scale up using Cloud Foundry. The buildpack ensures that your system automatically starts behaving as a cluster.
1717

18-
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-kubernetes/#scaling) section of *Use Docker with Minikube*.
18+
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-minikube/#scaling) section of *Use Docker with Minikube*.
1919

2020
## Cluster Infrastructure
2121

content/en/docs/refguide8/general/system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ For container-based deployments using Docker, Kubernetes, or Cloud Foundry, the
127127
* SAP AWS S3 Object Storage
128128
* SAP Azure Blob Storage
129129

130-
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-kubernetes/).
130+
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-minikube/).
131131

132132
### Storage types for Servers
133133

content/en/docs/refguide8/runtime/clustered-mendix-runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The main feature enabling clustering is Mendix's stateless runtime architecture.
1414

1515
Clustering support is built natively into our Cloud Foundry buildpack implementation. This means that you can simply scale up using Cloud Foundry. The buildpack ensures that your system automatically starts behaving as a cluster.
1616

17-
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-kubernetes/#scaling) section of *Use Docker with Minikube*.
17+
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-minikube/#scaling) section of *Use Docker with Minikube*.
1818

1919
## Cluster Infrastructure
2020

content/en/docs/refguide9/general/system-requirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ For container-based deployments using Docker, Kubernetes, or Cloud Foundry, the
232232
* SAP AWS S3 Object Storage
233233
* SAP Azure Blob Storage
234234

235-
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-kubernetes/).
235+
For container-mounted storage in Kubernetes, provided by an external storage class, see also [Use Docker with Minikube](/developerportal/deploy/run-mendix-on-minikube/).
236236

237237
### Storage Types for Servers
238238

content/en/docs/refguide9/runtime/clustered-mendix-runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The main feature enabling clustering is Mendix's stateless runtime architecture.
1515

1616
Clustering support is built natively into our Cloud Foundry buildpack implementation. This means that you can simply scale up using Cloud Foundry. The buildpack ensures that your system automatically starts behaving as a cluster.
1717

18-
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-kubernetes/#scaling) section of *Use Docker with Minikube*.
18+
Clustering is also supported on Kubernetes, but you will have to use a *StatefulSet*. There is more information on this in the [Some Notes on Scaling](/developerportal/deploy/run-mendix-on-minikube/#scaling) section of *Use Docker with Minikube*.
1919

2020
## Cluster Infrastructure
2121

0 commit comments

Comments
 (0)