HowTo:CS Launch - Revision history

Carnold: /* Launching a Database Using Helm */

2025-10-02T17:47:58Z

Launching a Database Using Helm

← Older revision		Revision as of 13:47, 2 October 2025
Line 58:		Line 58:

	'''UPDATE:''' These instructions used to show how to deploy an App using the Bitnami helm charts. Bitnami is now a paid product, so I have updated these instructions to use the groundhog2k helm charts which are currently community based. See our separate wiki page on Bitnami to see the old instructions and tips on migrating existing Bitnami deployments: [[CS Launch Bitnami]]		'''UPDATE:''' These instructions used to show how to deploy an App using the Bitnami helm charts. Bitnami is now a paid product, so I have updated these instructions to use the groundhog2k helm charts which are currently community based. See our separate wiki page on Bitnami to see the old instructions and tips on migrating existing Bitnami deployments: [[CS Launch Bitnami]]

			'''Alternative''' You can also choose to deploy a database manually using an official docker image, see [[CS_Launch_MariaDB]]

	Kubernetes supports Helm charts to automate deployment of software. There are existing Helm charts for many popular software projects, such as databases. Using a Helm chart can make setting up and updating complex software much easier. This guide will walk you through deploying MariaDB using a Helm chart from Groundhog2k.		Kubernetes supports Helm charts to automate deployment of software. There are existing Helm charts for many popular software projects, such as databases. Using a Helm chart can make setting up and updating complex software much easier. This guide will walk you through deploying MariaDB using a Helm chart from Groundhog2k.

Carnold: /* Launching a Database Using Helm */

2025-10-02T14:45:04Z

Launching a Database Using Helm

← Older revision		Revision as of 10:45, 2 October 2025
Line 77:		Line 77:
	# bug in chart requires this for now:		# bug in chart requires this for now:
	allowEmptyRootPassword: true		allowEmptyRootPassword: true
			rootPassword:
			value: 'ChangeMe'
	storage:		storage:
	requestedSize: 1Gi		requestedSize: 1Gi

Carnold at 13:47, 2 October 2025

2025-10-02T13:47:53Z

← Older revision		Revision as of 09:47, 2 October 2025
Line 42:		Line 42:
	* '''Click on the ''Create'' button'''		* '''Click on the ''Create'' button'''
	[[Image:Create_namespace.png]]		[[Image:Create_namespace.png]]


	== Creating a Secret ==		== Creating a Secret ==
Line 51:		Line 50:
	* '''Click on the ''Create'' button'''		* '''Click on the ''Create'' button'''
	* '''Select the ''Opaque'' tile''' as this type of secret is suited for storing passwords		* '''Select the ''Opaque'' tile''' as this type of secret is suited for storing passwords
	* Fill in '''Name''' with <code>~~mariadb~~</code>		* Fill in '''Name''' with <code>my-secret</code>
	* Fill in '''Key''' with <code>~~rootpass~~</code>		* Fill in '''Key''' with <code>my-pass</code>
	* Fill in '''Value''' with what you want to use as the password, for example: <code>ChangeMe</code>		* Fill in '''Value''' with what you want to use as the password, for example: <code>ChangeMe</code>
	* '''Click on the ''Create'' button'''		* '''Click on the ''Create'' button'''
Line 76:		Line 75:
	<pre>		<pre>
	settings:		settings:
	~~existingSecret~~: ~~mariadb~~		# bug in chart requires this for now:
	~~rootPassword~~:		allowEmptyRootPassword: true
	~~secretKey: rootpass~~
	storage:		storage:
	requestedSize: 1Gi		requestedSize: 1Gi

Carnold at 13:19, 2 October 2025

2025-10-02T13:19:13Z

← Older revision		Revision as of 09:19, 2 October 2025
Line 43:		Line 43:
	[[Image:Create_namespace.png]]		[[Image:Create_namespace.png]]

	== Launching a Database Using Helm==
			== Creating a Secret ==
			Kubernetes uses secrets to store sensitive information, such as passwords, in a secure manner.
			* Navigate to your '''Cluster Dashboard'''
			* '''Click on ''Storage''''' from the menu on the left
			* '''Click on ''Secrets''''' underneath ''Storage''
			* '''Click on the ''Create'' button'''
			* '''Select the ''Opaque'' tile''' as this type of secret is suited for storing passwords
			* Fill in '''Name''' with <code>mariadb</code>
			* Fill in '''Key''' with <code>rootpass</code>
			* Fill in '''Value''' with what you want to use as the password, for example: <code>ChangeMe</code>
			* '''Click on the ''Create'' button'''

			== Launching a Database Using Helm ==

	'''UPDATE:''' These instructions used to show how to deploy an App using the Bitnami helm charts. Bitnami is now a paid product, so I have updated these instructions to use the groundhog2k helm charts which are currently community based. See our separate wiki page on Bitnami to see the old instructions and tips on migrating existing Bitnami deployments: [[CS Launch Bitnami]]		'''UPDATE:''' These instructions used to show how to deploy an App using the Bitnami helm charts. Bitnami is now a paid product, so I have updated these instructions to use the groundhog2k helm charts which are currently community based. See our separate wiki page on Bitnami to see the old instructions and tips on migrating existing Bitnami deployments: [[CS Launch Bitnami]]
Line 65:		Line 78:
	existingSecret: mariadb		existingSecret: mariadb
	rootPassword:		rootPassword:
	secretKey: ~~root-pass~~		secretKey: rootpass
	storage:		storage:
	requestedSize: 1Gi		requestedSize: 1Gi

Carnold: /* Launching a Database Using Helm */

2025-10-02T13:13:09Z

Launching a Database Using Helm

← Older revision		Revision as of 09:13, 2 October 2025
Line 44:		Line 44:

	== Launching a Database Using Helm==		== Launching a Database Using Helm==
	Kubernetes supports Helm charts to automate deployment of software. There are existing Helm charts for many popular software projects, such as databases. Using a Helm chart can make setting up and updating complex software much easier. This guide will walk you through deploying MariaDB using a Helm chart from ~~Bitnami~~.
			'''UPDATE:''' These instructions used to show how to deploy an App using the Bitnami helm charts. Bitnami is now a paid product, so I have updated these instructions to use the groundhog2k helm charts which are currently community based. See our separate wiki page on Bitnami to see the old instructions and tips on migrating existing Bitnami deployments: [[CS Launch Bitnami]]

			Kubernetes supports Helm charts to automate deployment of software. There are existing Helm charts for many popular software projects, such as databases. Using a Helm chart can make setting up and updating complex software much easier. This guide will walk you through deploying MariaDB using a Helm chart from Groundhog2k.
	* Navigate to your '''Cluster Dashboard'''		* Navigate to your '''Cluster Dashboard'''
	* '''Click on ''Apps''''' from the menu on the left		* '''Click on ''Apps''''' from the menu on the left
	* '''Click on ''Charts''''' underneath ''Apps''		* '''Click on ''Charts''''' underneath ''Apps''
	* We need to find the MariaDB chart		* We need to find the MariaDB chart
	** Make sure to '''select ''~~Bitnami~~'' '''in the first drop down list		** Make sure to '''select ''groundhog2k'' '''in the first drop down list
	** '''Select ''Database'' '''from the catagories drop down list		** '''Select ''Database'' '''from the catagories drop down list
	** '''Click on the ''~~MariaDB~~'' tile'''		** '''Click on the ''mariadb'' tile'''
	* '''Click on the ''Install'' button'''		* '''Click on the ''Install'' button'''
	* '''Select the namespace from the drop down list''' where you want the database deployed to		* '''Select the namespace from the drop down list''' where you want the database deployed to
Line 59:		Line 62:
	* For our example, '''change the following options''':		* For our example, '''change the following options''':
	<pre>		<pre>
	~~auth~~:		settings:
	~~database~~: 'test-db'		existingSecret: mariadb
	~~username~~: 'test'		rootPassword:
	password~~: 'Insecure'~~		secretKey: root-pass
	~~primary:~~		storage:
	~~persistence~~:		requestedSize: 1Gi
	~~size~~: '~~1Gi~~'		keepPvc: true
			userDatabase:
			name:
			value: 'test-db'
			user:
			value: 'test'
			password:
			value: 'Insecure'
	</pre>		</pre>
	* '''Click on the ''Install'' button'''		* '''Click on the ''Install'' button'''

Carnold: /* Launching a Database Using Helm */

2025-09-17T13:42:37Z

Launching a Database Using Helm

← Older revision		Revision as of 09:42, 17 September 2025
Line 54:		Line 54:
	* '''Click on the ''Install'' button'''		* '''Click on the ''Install'' button'''
	* '''Select the namespace from the drop down list''' where you want the database deployed to		* '''Select the namespace from the drop down list''' where you want the database deployed to
			* Fill in '''Name''' with <code>mariadb</code> or a unique hostname you want to give your database
	* '''Click on the ''Next'' button'''		* '''Click on the ''Next'' button'''
	* You will be presented with a long list of options and their default values in yaml format		* You will be presented with a long list of options and their default values in yaml format
Line 59:		Line 60:
	<pre>		<pre>
	auth:		auth:
	database: test-db		database: 'test-db'
	username: test		username: 'test'
	password: Insecure		password: 'Insecure'
	primary:		primary:
	persistence:		persistence:
	size: 1Gi		size: '1Gi'
	</pre>		</pre>
	* '''Click on the ''Install'' button'''		* '''Click on the ''Install'' button'''

Carnold: /* Launching a Database Using Helm */

2025-05-08T16:25:00Z

Launching a Database Using Helm

← Older revision		Revision as of 12:25, 8 May 2025
Line 47:		Line 47:
	* Navigate to your '''Cluster Dashboard'''		* Navigate to your '''Cluster Dashboard'''
	* '''Click on ''Apps''''' from the menu on the left		* '''Click on ''Apps''''' from the menu on the left
	* We need to add the helm chart repository:
	** '''Click on ''Repositories''''' underneath ''Apps''
	** '''Click on the ''Create'' button'''
	** Fill in '''Name''' with <code>bitnami</code>
	** Fill in '''Index URL''' with <code>https://charts.bitnami.com/bitnami</code>
	** '''Click on the ''Create'' button'''
	* '''Click on ''Charts''''' underneath ''Apps''		* '''Click on ''Charts''''' underneath ''Apps''
	* We need to find the MariaDB chart		* We need to find the MariaDB chart

Carnold at 14:18, 8 May 2025

2025-05-08T14:18:14Z

← Older revision		Revision as of 10:18, 8 May 2025
Line 3:		Line 3:

	== Introduction ==		== Introduction ==
	This is a quick start guide for using the CS Launch website and kubernetes resources. It will walk you through setting up a basic website with database support. There is a separate guide that describes how to do all these steps using a command line terminal at [[HowTo:CS Launch Terminal]]		This is a quick start guide for using the CS Launch (formerly CS cloud) website and kubernetes resources. It will walk you through setting up a basic website with database support. There is a separate guide that describes how to do all these steps using a command line terminal at [[HowTo:CS Launch Terminal]]

	== Clusters ==		== Clusters ==

Carnold at 12:42, 18 April 2025

2025-04-18T12:42:51Z

← Older revision		Revision as of 08:42, 18 April 2025
Line 1:		Line 1:
			== Video Demo ==
			Link to a CS Launch demo created by Computer Science TA Wyatt Sweat: https://www.youtube.com/watch?v=BNmQfneAEzc&ab_channel=WyattSweat

	== Introduction ==		== Introduction ==
	This is a quick start guide for using the CS Launch website and kubernetes resources. It will walk you through setting up a basic website with database support. There is a separate guide that describes how to do all these steps using a command line terminal at [[HowTo:CS Launch Terminal]]		This is a quick start guide for using the CS Launch website and kubernetes resources. It will walk you through setting up a basic website with database support. There is a separate guide that describes how to do all these steps using a command line terminal at [[HowTo:CS Launch Terminal]]

Bbradner: Added secondary examples about the discovery ingress as students are skipping the note at the top about the difference between the endeavour and discovery ingress formats

2025-02-07T13:31:21Z

Added secondary examples about the discovery ingress as students are skipping the note at the top about the difference between the endeavour and discovery ingress formats

← Older revision		Revision as of 09:31, 7 February 2025
Line 104:		Line 104:
	* Make sure to '''select the same namespace as the web app'''.		* Make sure to '''select the same namespace as the web app'''.
	* '''Fill in ''Name''''' with a project unique name. Example: <code>test-ingress</code> The name must follow DNS naming rules.		* '''Fill in ''Name''''' with a project unique name. Example: <code>test-ingress</code> The name must follow DNS naming rules.
	* '''Fill in ''Request Host''''' with the hostname of the URL you want to map to. Example: <code>testdb.endeavour.cs.vt.edu</code> The Endeavour cluster on CS Launch allows you to map any *.endeavour.cs.vt.edu hostname to your ingress. Additionally, a TLS certificate is used to automatically encrypt your ingress traffic.		* '''Fill in ''Request Host''''' with the hostname of the URL you want to map to. Example: <code>testdb.endeavour.cs.vt.edu</code> The Endeavour cluster on CS Launch allows you to map any .endeavour.cs.vt.edu hostname to your ingress. Example 2: <code>testdb.discovery.cs.vt.edu</code> The Discovery cluster on CS Launch allows you to map any .discovery.cs.vt.edu hostname to your ingress. Additionally, a TLS certificate is used to automatically encrypt your ingress traffic.
	* '''Fill in ''Path''''' with ''Prefix'' value of <code>/</code> Using ''/'' will map the top level path, and all sub-paths of the URL to this deployment. You can create multiple sub-paths to the same hostname to different deployments allowing you to flesh out a URL running as multiple containers. Example: mapping /api/* to a deployment that runs the backend of your website.		* '''Fill in ''Path''''' with ''Prefix'' value of <code>/</code> Using ''/'' will map the top level path, and all sub-paths of the URL to this deployment. You can create multiple sub-paths to the same hostname to different deployments allowing you to flesh out a URL running as multiple containers. Example: mapping /api/* to a deployment that runs the backend of your website.
	* '''Select your application deployment from the ''Target Service'' drop down list'''. Example: <code>test-adminer</code>		* '''Select your application deployment from the ''Target Service'' drop down list'''. Example: <code>test-adminer</code>
Line 206:		Line 206:
	* Make sure to '''select the same namespace as the web app'''.		* Make sure to '''select the same namespace as the web app'''.
	* '''Fill in ''Name''''' with a project unique name. Example: <code>chatbot-ingress</code> The name must follow DNS naming rules.		* '''Fill in ''Name''''' with a project unique name. Example: <code>chatbot-ingress</code> The name must follow DNS naming rules.
	* '''Fill in ''Request Host''''' with the hostname of the URL you want to map to. Example: <code>chatbot.endeavour.cs.vt.edu</code> The Endeavour cluster on CS Launch allows you to map any *.endeavour.cs.vt.edu hostname to your ingress. Additionally, a TLS certificate is used to automatically encrypt your ingress traffic.		* '''Fill in ''Request Host''''' with the hostname of the URL you want to map to. Example: <code>chatbot.endeavour.cs.vt.edu</code> The Endeavour cluster on CS Launch allows you to map any .endeavour.cs.vt.edu hostname to your ingress. Example 2: <code>chatbot.discovery.cs.vt.edu</code> The Discovery cluster on CS Launch allows you to map any .discovery.cs.vt.edu hostname to your ingress. Additionally, a TLS certificate is used to automatically encrypt your ingress traffic.
	* '''Fill in ''Path''''' with ''Prefix'' value of <code>/</code> Using ''/'' will map the top level path, and all sub-paths of the URL to this deployment. You can create multiple sub-paths to the same hostname to different deployments allowing you to flesh out a URL running as multiple containers. Example: mapping /api/* to a deployment that runs the backend of your website.		* '''Fill in ''Path''''' with ''Prefix'' value of <code>/</code> Using ''/'' will map the top level path, and all sub-paths of the URL to this deployment. You can create multiple sub-paths to the same hostname to different deployments allowing you to flesh out a URL running as multiple containers. Example: mapping /api/* to a deployment that runs the backend of your website.
	* '''Select your application deployment from the ''Target Service'' drop down list'''. Example: <code>test-chatbot</code>		* '''Select your application deployment from the ''Target Service'' drop down list'''. Example: <code>test-chatbot</code>