Command Center SSH Bitbucket - Revision history

Rwilliams: /* Background */

2025-05-15T14:12:17Z

Background

← Older revision		Revision as of 14:12, 15 May 2025
Line 2:		Line 2:

	== Background ==		== Background ==
	Its possible to connect Command Center to Bitbucket without using HTTPS, but instead using SSH. This type of connection is not possible via the ~~standard Bitbucket~~ Connector in the UI as that only supports HTTPS connections. Follow this procedure to leverage an SSH connection to Bitbucket.		Its possible to connect Command Center to Bitbucket without using HTTPS, but instead using SSH. This type of connection is not possible via the Custom Git Connector in the UI as that only supports HTTPS connections. Follow this procedure to leverage an SSH connection to Bitbucket.

	== Process Overview ==		== Process Overview ==

Rwilliams: /* Background */

2025-05-15T14:10:01Z

Background

← Older revision		Revision as of 14:10, 15 May 2025
Line 2:		Line 2:

	== Background ==		== Background ==
	Its possible to connect Command Center to Bitbucket without using HTTPS, but instead using ~~Bitbucket~~. This type of connection is not possible via the standard Bitbucket Connector in the UI as that only supports HTTPS connections. Follow this procedure to leverage an SSH connection to Bitbucket.		Its possible to connect Command Center to Bitbucket without using HTTPS, but instead using SSH. This type of connection is not possible via the standard Bitbucket Connector in the UI as that only supports HTTPS connections. Follow this procedure to leverage an SSH connection to Bitbucket.

	== Process Overview ==		== Process Overview ==

Rwilliams: /* Additional Notes */

2025-02-07T20:36:42Z

Additional Notes

← Older revision		Revision as of 20:36, 7 February 2025
Line 13:		Line 13:

	=== Additional Notes ===		=== Additional Notes ===
	Although this page details the process for Bitbucket, the same technique can be applied to GitLab as well. The overall process would be the same.		Although this page details the process for Bitbucket, the same technique can be applied to other repositories such as GitLab as well. The overall process would be the same.

	== GitHub Repository Initial Setup ==		== GitHub Repository Initial Setup ==

Rwilliams: /* Process Overview */

2025-02-07T20:35:50Z

Process Overview

← Older revision		Revision as of 20:35, 7 February 2025
Line 11:		Line 11:
	* Creating a Custom Data Source in Command Center to access the three scripts		* Creating a Custom Data Source in Command Center to access the three scripts
	* Leveraging the Custom Data Source from the desired Command Center Project		* Leveraging the Custom Data Source from the desired Command Center Project

			=== Additional Notes ===
			Although this page details the process for Bitbucket, the same technique can be applied to GitLab as well. The overall process would be the same.

	== GitHub Repository Initial Setup ==		== GitHub Repository Initial Setup ==

Rwilliams: /* Connecting Command Center to Bitbucket using SSH */

2025-02-07T20:33:40Z

Connecting Command Center to Bitbucket using SSH

← Older revision		Revision as of 20:33, 7 February 2025
Line 97:		Line 97:
	* clone.sh		* clone.sh
	** Requires the following to be updated		** Requires the following to be updated
	*** USER_NAME		*** REPO - Obtain this path from the repository itself, there is normally a link that can be clicked to copy the path
	*** REPO
	*** BRANCH_NAME		*** BRANCH_NAME
	* pull.sh		* pull.sh
Line 112:		Line 111:
	#!/bin/bash		#!/bin/bash

	REPO="ssh://git@bitbucket.org~~/<USER_NAME>~~/<REPO>.git"		REPO="ssh://git@bitbucket.org/<REPO>.git"
	BRANCH="<BRANCH_NAME>"		BRANCH="<BRANCH_NAME>"

Rwilliams at 15:48, 4 February 2025

2025-02-04T15:48:54Z

← Older revision		Revision as of 15:48, 4 February 2025
Line 233:		Line 233:

	== Create a new Custom Data Source ==		== Create a new Custom Data Source ==
			Once the scripts have been created and placed into the GitHub repository, make the scripts accessible to Command Center by adding the directory as a new Custom Data Source
	Once the scripts have been created, make the scripts accessible to Command Center by adding the directory as a new Custom Data Source
	* When naming the Custom Data Source consider using a name that will make it easily identifiable as to what repository and branch the Custom Data Source is pointing towards.		* When naming the Custom Data Source consider using a name that will make it easily identifiable as to what repository and branch the Custom Data Source is pointing towards.
	* There will be one Custom Data source created for a single repo/branch used by Command Center		* There will be one Custom Data source created for a single repo/branch used by Command Center
	** If two branches from the same repository are required, there will be two Custom Data Sources Required.		** If two branches from the same repository are required, there will be two Custom Data Sources Required.


	== Leveraging the Custom Data Source from Command Center ==		== Leveraging the Custom Data Source from Command Center ==

	At this point, when the Command Center Project is created, simply select the Custom Data Source as the Data Source Credential and ~~you should be all set~~.		At this point, when the Command Center Project is created, simply select the Custom Data Source as the Data Source Credential. Once the project is created, it should leverage the scripts to perform any operations required on the Bitbucket repo. Initially it should show the list of resource files that are found when running validation. That is a good check for the clone.sh and pull.sh scripts. The pushfiles.sh is used when committing files back into the repository so that could take the form of a returned translation, or even a pseudo-localization file.

Rwilliams at 15:45, 4 February 2025

2025-02-04T15:45:01Z

← Older revision		Revision as of 15:45, 4 February 2025
Line 12:		Line 12:
	* Leveraging the Custom Data Source from the desired Command Center Project		* Leveraging the Custom Data Source from the desired Command Center Project

	== GitHub Repository ==		== GitHub Repository Initial Setup ==
	Create a new repository in GitHub that will be used for storing the three custom scripts.		Create a new repository in GitHub that will be used for storing the three custom scripts.
	* Create top level directory for storing the scripts		* Create top level directory for storing the scripts
Line 91:		Line 91:
	At this point the key has been validated in Bitbucket as working.		At this point the key has been validated in Bitbucket as working.

	**NOTE: At this point you have a working SSH key for Bitbucket. It's		<B>NOTE:</B> At this point you have a working SSH key for Bitbucket. It's important to realize that since this is in a container it will disappear upon reinstall/upgrade of Command Center. Making a backup of the .ssh directory in the container and having it available offline for the future can help to reduce the effort of recreating this process when this occurs
	important to realize that since this is in a container it will
	disappear upon reinstall/upgrade of Command Center. Making a backup
	of the .ssh directory and having it available for the future can help
	to reduce the effort of recreating this process when this occurs**

			== Script Additions to GitHub Repository ==
	~~## Procedure~~		Add the custom scripts listed below to the repository directory in GitHub that previously created. Be sure to update the scripts with your custom information as the scripts will not work as written, the details are required.
			* clone.sh
			** Requires the following to be updated
	~~### Create a Repo for~~ the required ~~Shell Scripts~~		*** USER_NAME
			*** REPO
			*** BRANCH_NAME
	*clone.sh		* pull.sh
	**USER_NAME		** Requires the following to be updated
	**REPO		*** BRANCH_NAME
	**BRANCH_NAME		* pushfiles.sh
	*pull.sh		** No modifications are required in this script.
	** BRANCH_NAME
	*pushfiles.sh
	** No ~~modification needed~~

	~~Add the contents below to each of the respective files, being sure to~~
	~~update the user_name/repo/branch where indicated~~.

	=== clone.sh ===		=== clone.sh ===
Line 123:		Line 113:

	REPO="ssh://git@bitbucket.org/<USER_NAME>/<REPO>.git"		REPO="ssh://git@bitbucket.org/<USER_NAME>/<REPO>.git"
	BRANCH="BRANCH_NAME"		BRANCH="<BRANCH_NAME>"

	echo "Using credential: ${CREDENTIAL_NAME}"		echo "Using credential: ${CREDENTIAL_NAME}"
Line 166:		Line 156:
	#!/bin/bash		#!/bin/bash

	BRANCH="BRANCH_NAME"		BRANCH="<BRANCH_NAME>"

	echo "Using credential: ${CREDENTIAL_NAME}"		echo "Using credential: ${CREDENTIAL_NAME}"

Rwilliams at 15:35, 4 February 2025

2025-02-04T15:35:47Z

← Older revision		Revision as of 15:35, 4 February 2025
Line 74:		Line 74:
	** Confirm the key has r/w access to the repo as noted in the next section		** Confirm the key has r/w access to the repo as noted in the next section

	**You ~~will need reset~~ tomcatuser to ~~/usr/sbin/nologin shell from~~		=== Command Center Container ===
	~~/bin/bash~~ as ~~part of~~ the below actions**
			Return to the Command Center Container to perform a connection test to the desired repository. You should still be tomcatuser at this point. If not, switch to tomcatuser as before. Perform the below activities and then be sure to switch the tomcatuser shell back to nologin.

	cd /tmp/		cd /tmp/

Rwilliams at 15:32, 4 February 2025

2025-02-04T15:32:10Z

← Older revision		Revision as of 15:32, 4 February 2025
Line 60:		Line 60:
	+----[SHA256]-----+		+----[SHA256]-----+

	~~- Add~~ the key to the Bitbucket ~~Account~~		Copy the public key that was created as it will need to be input into the Bitbucket Cloud Repo for the account that is being leveraged in Bitbucket. Note this key is applied at the user level and not the repository level.
	~~- This~~ is ~~performed on the~~ Bitbucket ~~Server~~
	~~- SSH Key must be added to an account which has write access to the~~
	~~repo~~.
	~~- Click on Settings Icon to left of the User Icon~~
	~~- Select SSH Keys in the left column~~
	~~- Click on Add Key~~
	~~- Provide a label as appropriate~~
	~~- Paste the public~~ key ~~(Be sure it's~~ the ~~public key!)~~
	~~- In this example it is id\_rsa.pub~~
	~~- Select Add key~~ and the ~~key should be listed as available~~
	~~- Confirm the key has r/w access to the repo~~

	The ~~system doesn't allow for~~ a ~~shell to be used by tomcatuser, so~~ it		=== Bitbucket Cloud Repo ===
	~~must temporarily be set to allow~~ this ~~for testing~~ and ~~setting up~~ the
	~~ssh~~ key.		Log into the Bitbucket Cloud Server as user as the user the key will be applied. The SSH Key must be added to an account which has write access to the repo.
			* Click on Settings Icon to left of the User Icon
			* Select SSH Keys in the left column
			* Click on Add Key
			* Provide a label as appropriate
			* Paste the public key (Be sure it's the public key!)
			** In this example it is id_rsa.pub
			* Select Add key and the key should be listed as available
			** Confirm the key has r/w access to the repo as noted in the next section

	**You will need reset tomcatuser to /usr/sbin/nologin shell from		**You will need reset tomcatuser to /usr/sbin/nologin shell from

Rwilliams at 15:24, 4 February 2025

2025-02-04T15:24:22Z

← Older revision		Revision as of 15:24, 4 February 2025
Line 4:		Line 4:
	Its possible to connect Command Center to Bitbucket without using HTTPS, but instead using Bitbucket. This type of connection is not possible via the standard Bitbucket Connector in the UI as that only supports HTTPS connections. Follow this procedure to leverage an SSH connection to Bitbucket.		Its possible to connect Command Center to Bitbucket without using HTTPS, but instead using Bitbucket. This type of connection is not possible via the standard Bitbucket Connector in the UI as that only supports HTTPS connections. Follow this procedure to leverage an SSH connection to Bitbucket.

	~~### Github~~ Repo ~~for Storing Scripts~~		== Process Overview ==
			* Creation of a GitHub repo for storing three custom scripts (Using GitHub as example for this)
			* Creation of a pub/private key in the Command Center Container
			* Adding the public key to Bitbucket Cloud Repository
			* Adding three custom scripts to the GitHub Repo
			* Creating a Custom Data Source in Command Center to access the three scripts
			* Leveraging the Custom Data Source from the desired Command Center Project

	~~- Requires~~ a ~~repo to place Data Source Shell Scripts~~		== GitHub Repository ==
	~~- Similar~~ in ~~functionality to transforms~~		Create a new repository in GitHub that will be used for storing the three custom scripts.
	- Create top level directory for storing the scripts		* Create top level directory for storing the scripts
	- This directory will contain the following three scripts as described		* This directory will contain the following three scripts as described later in the document.
	later in the document.		** clone.sh
	- clone.sh		** pull.sh
	- pull.sh		** pushfiles.sh
	- pushfiles.sh

			== Bitbucket Cloud Repository Configuration ==

	~~### Bitbucket Cloud Repo~~		=== Command Center Container ===

	~~- Need an ssh~~ public key created in the ~~container~~		The Bitbucket repo requires a public key be added to it that is created in Command Center by the connecting user. Below is the process for creating the key to be shared with the Bitbucket Cloud Repo.
	- Perform this within the container itself for Command Center		* Perform this within the container itself for Command Center
	- Do not add a password to the key		* Do not add a password to the key pair when prompted
	- The key will be in the tomcatuser home directory so it must be		* The key will be in the tomcatuser home directory so it must be created by the tomcatuser preferably.
	created by the tomcatuser preferably.		* You will need set tomcatuser to /bin/bash shell from /usr/sbin/nologin as part of the below actions

	**You will need set tomcatuser to /bin/bash shell from		Follow the below command after logging into the VM and then logging into the Command Center container as the root user.
	~~/usr/sbin/nologin as part of~~ the below actions**

	~~Here is~~ the ~~output from~~ the ~~command line:~~

	root@d9dfe772ea55:/usr/local/tomcat# chsh tomcatuser		root@d9dfe772ea55:/usr/local/tomcat# chsh tomcatuser