Merge pull request #9 from philibea/handle-dns-prefix

feat(dns): handle prefix

Author: philibea

.github/workflows/main.yaml

@@ -51,11 +51,11 @@ jobs:
           type: deploy
           scw_access_key:  ${{ secrets.ACCESS_KEY }}
           scw_secret_key: ${{ secrets.SECRET_KEY }}
-          scw_project_id: 9d1d9183-bc98-4a92-ab54-be5ef9ada957
           scw_containers_namespace_id: ae28eaf1-3b94-4660-bce0-9b0e0a5d1062
           scw_registry: rg.fr-par.scw.cloud/testong/shire-testing:latest
           scw_container_port: "80"
           scw_dns: containers.philibeaux.fr
+          scw_dns_prefix: testing-github
 
       - name: check output 
         shell: bash
@@ -101,10 +101,10 @@ jobs:
           type: teardown
           scw_access_key:  ${{ secrets.ACCESS_KEY }}
           scw_secret_key: ${{ secrets.SECRET_KEY }}
-          scw_project_id: 9d1d9183-bc98-4a92-ab54-be5ef9ada957
           scw_containers_namespace_id: ae28eaf1-3b94-4660-bce0-9b0e0a5d1062
           scw_registry: rg.fr-par.scw.cloud/testong/shire-testing:latest
           scw_dns: containers.philibeaux.fr
+          scw_dns_prefix: testing-github
 
       - name: check output 
         shell: bash

.github/workflows/publish.yaml

@@ -6,6 +6,8 @@ on:
   push:
     branches:
       - main
+    tags:
+      - 'v*.*.*'
 
 jobs:
   publish:
@@ -29,6 +31,7 @@ jobs:
             type=schedule
             type=ref,event=branch
             type=ref,event=pr
+            type=ref,event=tag
             type=semver,pattern={{version}}
             type=semver,pattern={{major}}.{{minor}}
             type=semver,pattern={{major}}

README.md

@@ -1,2 +1,47 @@
-# scaleway-containers-deploy
-scaleway deploy container with registry and custom endpoint dns
+# Scaleway Containers Deploy
+
+This github action makes it easy to deploy on the containers product from the path of a registry scaleway.
+It adds the functionality of using its own domain which must be on scaleway.
+
+You can check the `action.yaml` file to see how it works.
+
+# Exemple of use:
+
+scw_access_key, scw_secret_key & scw_containers_namespace_id will always be necessary 
+
+## simple deploy
+
+| input name                  | value                                  |
+| --------------------------- | -------------------------------------- |
+| type                        | deploy                                 |
+| scw_registry                | rg.fr-par.scw.cloud/test/images:latest |
+
+## simple teardown
+
+| input name                  | value                                  |
+| --------------------------- | -------------------------------------- |
+| type                        | teardown                               |
+| scw_registry                | rg.fr-par.scw.cloud/test/images:latest |
+
+## dns deploy
+
+| input name                  | value                                  |
+| --------------------------- | -------------------------------------- |
+| type                        | deploy                                 |
+| scw_registry                | rg.fr-par.scw.cloud/test/images:latest |
+| scw_dns                     | containers.test.fr                     |
+| scw_dns_prefix (optional)   | testing                                |
+
+
+if not define scw_dns_prefix, the action will use the default value: "name of you created container"
+
+This created containers will be based on the tag name of the registry.
+
+## dns teardown
+
+| input name                  | value                                  |
+| --------------------------- | -------------------------------------- |
+| type                        | teardown                               |
+| scw_registry                | rg.fr-par.scw.cloud/test/images:latest |
+| scw_dns                     | containers.test.fr                     |
+| scw_dns_prefix (optional)   | testing                                |

action.yaml

@@ -11,12 +11,12 @@ inputs:
   scw_secret_key: 
     description: "secret key ( https://console.scaleway.com/project/credentials )"
     required: true
-  scw_project_id:
-    description: "Project ID"
-    required: true
+  # scw_project_id:
+  #   description: "Project ID"
+  #   required: true
   scw_containers_namespace_id:
     description: "default namespace id where your container will be deploy, if this not required, this action will create a namespace and we need projectID to be set."
-    required: false
+    required: true
   scw_registry:
     description: "From your scaleway registry ( format: rg.$REGION.scw.cloud/$NAMESPACE/$IMAGE:$TAG )"
     required: true
@@ -27,6 +27,9 @@ inputs:
   scw_dns:
     description: "DNS name where your container will be available"
     required: false
+  scw_dns_prefix:
+    description: "DNS name where your container will be available"
+    required: false
 
   # scw_debug:
   #   description: "debug log api call"
@@ -39,7 +42,7 @@ outputs:
   scw_container_id:
     description: "ID of your container inside your namespace"
   container_url: 
-    description: 'Url of your container deployed'
+    description: 'Url of your deployed container'
   url:
     description: "Url with dns set"
 
@@ -51,10 +54,11 @@ runs:
     - ${{ inputs.type }}
     - ${{ inputs.scw_access_key }}
     - ${{ inputs.scw_secret_key }}
-    - ${{ inputs.scw_project_id }}
+    # - ${{ inputs.scw_project_id }}
     - ${{ inputs.scw_containers_namespace_id }}
     - ${{ inputs.scw_registry }}
     - ${{ inputs.scw_container_port }}
     - ${{ inputs.scw_dns }}
+    - ${{ inputs.scw_dns_prefix }}
     # - ${{ inputs.scw_debug }}
 

container.go

@@ -96,43 +96,33 @@ func DeleteContainer(
 
 }
 
-func GetOrCreateContainersNamespace(
+func GetContainersNamespace(
 	client *scw.Client,
 	Region scw.Region,
 ) (*container.Namespace, error) {
 
 	// OPTIONAL ENV VARIABLES
 	ContainersNamespaceId := os.Getenv(EnvContainerNamespaceID)
 
-	api := container.NewAPI(client)
-
-	if ContainersNamespaceId != "" {
-
-		namespace, err := api.GetNamespace(&container.GetNamespaceRequest{
-			Region:      Region,
-			NamespaceID: ContainersNamespaceId,
-		})
+	if ContainersNamespaceId == "" {
 
-		if err != nil {
-			fmt.Println("unable to get namespace: ", err)
-		} else {
-			return namespace, nil
-		}
+		return nil, fmt.Errorf("containers namespace id not found")
 	}
 
-	Description := "Namespace created by a github action ( philibea/scaleway-action-container )"
+	api := container.NewAPI(client)
 
-	createdNamespace, err := api.CreateNamespace(&container.CreateNamespaceRequest{
-		Description: &Description,
+	namespace, err := api.GetNamespace(&container.GetNamespaceRequest{
 		Region:      Region,
+		NamespaceID: ContainersNamespaceId,
 	})
 
 	if err != nil {
-		fmt.Println("unable to create namespace: ", err)
-		return nil, err
+		fmt.Println("unable to get namespace: ", err)
+	} else {
+		return namespace, nil
 	}
 
-	return createdNamespace, nil
+	return namespace, nil
 }
 
 func isContainerAlreadyCreated(
@@ -240,6 +230,10 @@ func SetCustomDomainContainer(
 	Hostname string,
 ) (*container.Domain, error) {
 
+	if Hostname == "" {
+		return nil, fmt.Errorf("hostname is required")
+	}
+
 	api := container.NewAPI(client)
 
 	ResListDomains, _ := api.ListDomains(&container.ListDomainsRequest{

dns.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"os"
 	"time"
 
 	container "github.com/scaleway/scaleway-sdk-go/api/container/v1beta1"
@@ -15,10 +16,13 @@ const (
 )
 
 const (
-	TTL  = uint32(360)
 	TYPE = "CNAME"
 )
 
+var (
+	TTL = uint32(360)
+)
+
 func WaitForDNS(
 	client *scw.Client,
 	DNSZone string,
@@ -64,20 +68,28 @@ func WaitForDNS(
 
 func DeleteDNSRecord(
 	client *scw.Client,
-	DNSZone string,
 	Container *container.Container,
+	DNSZone string,
 ) (*domain.UpdateDNSZoneRecordsResponse, error) {
-	fmt.Println("Update Zone DNS")
+	fmt.Println("Update Zone DNS - Delete")
 
 	api := domain.NewAPI(client)
 
 	Data := Container.DomainName + "."
 
+	Prefix := os.Getenv(EnvDNSPrefix)
+
+	var Name string = Container.Name
+
+	if Prefix != "" {
+		Name = Prefix
+	}
+
 	IDFields := &domain.RecordIdentifier{
-		Name: Container.Name,
+		Name: Name,
 		Data: &Data,
 		Type: TYPE,
-		//TTL:  TTL,
+		TTL:  &TTL,
 	}
 
 	Changes := []*domain.RecordChange{
@@ -104,23 +116,28 @@ func DeleteDNSRecord(
 
 func AddDNSRecord(
 	client *scw.Client,
-	DNSZone string,
 	Container *container.Container,
+	DNSZone string,
+) (string, error) {
 
-) (*domain.UpdateDNSZoneRecordsResponse, error) {
-
-	fmt.Println("Update Zone DNS")
+	fmt.Println("Update Zone DNS - Add")
 
 	api := domain.NewAPI(client)
 
-	Data := Container.DomainName + "."
+	Prefix := os.Getenv(EnvDNSPrefix)
+
+	var Name string = Container.Name
+
+	if Prefix != "" {
+		Name = Prefix
+	}
 
 	Records := []*domain.Record{
 		{
-			Name: Container.Name,
+			Name: Name,
 			Type: TYPE,
 			TTL:  TTL,
-			Data: Data,
+			Data: Container.DomainName + ".",
 		},
 	}
 
@@ -132,16 +149,17 @@ func AddDNSRecord(
 		},
 	}
 
-	records, err := api.UpdateDNSZoneRecords(
+	_, err := api.UpdateDNSZoneRecords(
 		&domain.UpdateDNSZoneRecordsRequest{
 			DNSZone: DNSZone,
 			Changes: Changes,
 		})
 
 	if err != nil {
-
-		return nil, err
+		return "", err
 	}
 
-	return records, nil
+	Hostname := Name + "." + DNSZone
+
+	return Hostname, nil
 }