Commit 122c0901 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

fix: document S3_DEPLOY_ARGS variable

parent 43d2d2e9

README.md

+1 −10
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ The S3 template uses some global configuration used throughout all jobs. 
| :lock: `S3_SECRET_KEY` | Default S3 service Secret Key                 | **has to be defined** |

| `S3_BASE_BUCKET_NAME`  | Base bucket name                              | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |

| `S3_PREFIX`            | Default S3 prefix to use as a root destination to upload objects in the S3 bucket | _none_ |

| `S3_SCRIPTS_DIR`       | Directory where S3 hook scripts are located   | `.`|



#### Using other S3-compatible systems than AWS
@@ -212,11 +213,6 @@ variables: 
  S3_PROD_BUCKET_NAME: "acme-bucket-shared"

  # segregate envs with prefixes

  S3_PREFIX: "$CI_ENVIRONMENT_SLUG"

  # envs url

  S3_REVIEW_ENVIRONMENT_URL: "https://acme-bucket-shared.s3-website.public.domain.com/$CI_ENVIRONMENT_SLUG"

  S3_INTEG_ENVIRONMENT_URL: "https://acme-bucket-shared.s3-website.public.domain.com/$CI_ENVIRONMENT_SLUG"

  S3_STAGING_ENVIRONMENT_URL: "https://acme-bucket-shared.s3-website.public.domain.com/$CI_ENVIRONMENT_SLUG"

  S3_PROD_ENVIRONMENT_URL: "https://acme-bucket-shared.s3-website.public.domain.com/$CI_ENVIRONMENT_SLUG"

```



#### Hybrid policy
@@ -232,11 +228,6 @@ variables: 
  S3_PROD_BUCKET_NAME: "acme-bucket-prod"

  # segregate review envs with prefixes

  S3_REVIEW_PREFIX: "$CI_ENVIRONMENT_SLUG"

  # envs url

  S3_REVIEW_ENVIRONMENT_URL: "https://acme-bucket-review.s3-website.public.domain.com/$CI_ENVIRONMENT_SLUG"

  S3_INTEG_ENVIRONMENT_URL: "https://acme-bucket-integ.s3-website.public.domain.com"

  S3_STAGING_ENVIRONMENT_URL: "https://acme-bucket-staging.s3-website.public.domain.com"

  S3_PROD_ENVIRONMENT_URL: "https://acme-bucket-prod.s3-website.public.domain.com"

```



### Deployment jobs

kicker.json

+7 −1
Original line number Diff line number Diff line
@@ -46,7 +46,7 @@ 
    },

    {

      "name": "S3_DEPLOY_ARGS",

      "description": "directory where S3 scripts (templates, hook scripts) are located",

      "description": "[s3cmd](https://s3tools.org/usage) command and options to deploy files to the bucket",

      "default": "sync --recursive --delete-removed --acl-public --no-mime-magic --guess-mime-type",

      "advanced": true

    },
@@ -74,6 +74,12 @@ 
    {

      "name": "S3_PREFIX",

      "description": "Default S3 prefix to use as a root destination to upload objects in the S3 bucket"

    },

    {

      "name": "S3_SCRIPTS_DIR",

      "description": "Directory where S3 hook scripts are located",

      "default": ".",

      "advanced": true

    }

  ],

  "features": [