.drone.yml

@@ -16,8 +16,9 @@ steps:
         --PORTAINER_EP=CICD-runner
         --GITEA_API_KEY=f449c74ec7f04e54fe1e481eae43492b34cea406
         --DEPLOY_REPO_URL=${DRONE_REPO_LINK}
-        --DEPLOY_BRANCH=${DRONE_COMMIT_BRANCH}
+        --DEPLOY_REF=${DRONE_COMMIT_REF}
         --DEPLOY_HOST=dvdemo.privatedns.org
+        --DEPLOY_NAME=${DRONE_COMMIT_SHA}
 
 trigger:
   event:

deploy/portainer/.env

@@ -3,5 +3,7 @@ PORTAINER_API_KEY=ptr_RwxH2Cd+htdD2FoFiG46erT9beyvj9VoF3BrQPtDH3Q=
 PORTAINER_EP=CICD-runner
 GITEA_API_KEY=f449c74ec7f04e54fe1e481eae43492b34cea406
 DEPLOY_REPO_URL=https://dvgit.privatedns.org/lars/DeployTests
-DEPLOY_BRANCH=main
-DEPLOY_HOST=dvdemo.privatedns.org
+DEPLOY_REF=refs/heads/main
+DEPLOY_HOST=dvdemo.privatedns.org
+DEPLOY_PROJECT=ManualDeployTests
+DEPLOY_NAME=ManualDeploy

deploy/portainer/deploy.py

@@ -19,8 +19,9 @@ required_env_vars = {
     'PORTAINER_EP': 'Portainer Environment EndPoint to deploy to',
     'GITEA_API_KEY': 'API-Key to access Gitea instance',
     'DEPLOY_REPO_URL': 'The repository URL to deploy',
-    'DEPLOY_BRANCH': 'The branch to deploy',
+    'DEPLOY_REF': 'The git ref to deploy',
     'DEPLOY_HOST': 'The host name under which the deployment will be reachable',
+    'DEPLOY_NAME': 'Custom name to use as the deployment name',
 }
 
 # Try getting all arguments from (in order): 1 command line, 2 .env file, 3 Environment
@@ -43,14 +44,26 @@ if not_parsed:
     parser.print_help()
     sys.exit(1)
 
-deploy_webhook = str(uuid.uuid4())
+# Deploy variables to substitute in portainer deploy template
+deploy_variables = {key: getattr(args, key) for key in 
+    ['DEPLOY_REPO_URL', 'DEPLOY_HOST', 'DEPLOY_NAME', 'DEPLOY_REF']
+}
+deploy_variables['DEPLOY_WEBHOOK'] = str(uuid.uuid4())
+
+portainer=args.PORTAINER
+portainer_api_key=args.PORTAINER_API_KEY
+portainer_ep=args.PORTAINER_EP
+gitea_api_key=args.GITEA_API_KEY
+deploy_repo=deploy_variables['DEPLOY_REPO_URL']
+deploy_webhook=deploy_variables['DEPLOY_WEBHOOK']
+deploy_ref=deploy_variables['DEPLOY_REF']
 
 ### Find CICD-runner portainer environment endpointId ###
 portainer_headers = {
     'Content-Type': 'application/json',
-    'X-API-Key': args.PORTAINER_API_KEY
+    'X-API-Key': portainer_api_key,
 }
-endpoint_url = f'{args.PORTAINER}/api/endpoints'
+endpoint_url = f'{portainer}/api/endpoints'
 json_endpoints = None
 try:
     response = requests.get(endpoint_url, headers=portainer_headers)
@@ -62,20 +75,14 @@ except requests.exceptions.RequestException as err:
 
 endpoint_id = None
 for endpoint in json_endpoints:
-    if endpoint["Name"] == args.PORTAINER_EP:
+    if endpoint["Name"] == portainer_ep:
         endpoint_id = endpoint["Id"]
         break
 if endpoint_id is None:
-    raise Exception(f'Portainer endpoint \'{args.PORTAINER_EP}\' not found.')
+    raise Exception(f'Portainer endpoint \'{portainer_ep}\' not found.')
 else:
-    print(f'Found portainer endpoint \'{args.PORTAINER_EP}\' has id: \'{endpoint_id}\'.')
+    print(f'Found portainer endpoint \'{portainer_ep}\' has id: \'{endpoint_id}\'.')
 
-repo_url = urlparse(args.DEPLOY_REPO_URL)
-gitea = f"{repo_url.scheme}://{repo_url.netloc}"
-repo_path = repo_url.path
-repo_parts = repo_path.strip('/').split('/')
-owner = repo_parts[0]
-repo = repo_parts[1]
 
 ### Template substitution for the portainer stack deployment ###
 portainer_deploy_payload = {
@@ -83,31 +90,31 @@ portainer_deploy_payload = {
     "deploy/portainer/portainer_deploy.docker-compose.yml"
   ],
   "autoUpdate": {
-    "webhook": deploy_webhook
+    "webhook": f"{deploy_variables['DEPLOY_WEBHOOK']}"
   },
   "composeFile": "docker-compose.yml",
   "env": [
     {
       "name": "HOST",
-      "value": args.DEPLOY_HOST
+      "value": f"{deploy_variables['DEPLOY_HOST']}"
     },
     {
       "name": "COMPOSE_PROJECT_NAME",
-      "value": args.DEPLOY_BRANCH
+      "value": f"{deploy_variables['DEPLOY_NAME']}"
     }
   ],
   "fromAppTemplate": False,
-  "name": f"{owner}_{repo}_{args.DEPLOY_BRANCH.replace('/', '_')}".lower(),
+  "name": f"{deploy_variables['DEPLOY_NAME']}",
   "repositoryAuthentication": True,
   "repositoryUsername": "cicd",
   "repositoryPassword": "gJ6@$7ZjWGyV4%i", 
-  "repositoryReferenceName": f"refs/heads/{args.DEPLOY_BRANCH}",
-  "repositoryURL": args.DEPLOY_REPO_URL,
+  "repositoryReferenceName": f"{deploy_variables['DEPLOY_REF']}",
+  "repositoryURL": f"{deploy_variables['DEPLOY_REPO_URL']}",
   "tlsskipVerify": False
 }
 
 ### Deploy to portainer ###
-deploy_url = f'{args.PORTAINER}/api/stacks/create/standalone/repository?endpointId={endpoint_id}'
+deploy_url = f'{portainer}/api/stacks/create/standalone/repository?endpointId={endpoint_id}'
 try:
     response = requests.post(deploy_url, headers=portainer_headers, json=portainer_deploy_payload)
     response.raise_for_status()  # Raise HTTPError for bad requests
@@ -117,20 +124,30 @@ except requests.exceptions.RequestException as err:
     raise Exception(f'Could not deploy portainer stack: {err}')
 
 ### Add Webhook to Gitea ###
+repo_url = urlparse(deploy_repo)
+gitea = f"{repo_url.scheme}://{repo_url.netloc}"
+repo_path = repo_url.path
+repo_parts = repo_path.strip('/').split('/')
+owner = repo_parts[0]
+repo = repo_parts[1]
+
+ref_parts = deploy_ref.strip('/').split('/')
+branch = ref_parts[-1]
+
 webhook_payload = {
     "type": "gitea",
-    "branch_filter": f"{args.DEPLOY_BRANCH}",
+    "branch_filter": f"{branch}",
     "config": {
-        "url": f"{args.PORTAINER}/api/stacks/webhooks/{deploy_webhook}",
+        "url": f"{portainer}/api/stacks/webhooks/{deploy_webhook}",
         "content_type": "json"
     },
     "events": ["push"],  # You can specify other events as needed
     "active": True
 }
 
-webhook_url = f'{gitea}/api/v1/repos/{repo_path}/hooks'
+webhook_url = f'{gitea}/api/v1/repos/{owner}/{repo}/hooks'
 webhook_headers = {
-    "Authorization": f"token {args.GITEA_API_KEY}"
+    "Authorization": f"token {gitea_api_key}"
 }
 try:
     response = requests.post(webhook_url, headers=webhook_headers, json=webhook_payload)