Merge pull request #3679 from gjtempleton/CA-Chart-Rename

Return cluster-autoscaler-chart Chart name to cluster-autoscaler

.github/workflows/release.yaml

@@ -4,16 +4,24 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Fetch history
-        run: git fetch --prune --unshallow
+        with:
+          fetch-depth: 0
+
       - name: Configure Git
         run: |
           git config user.name "${GITHUB_ACTOR}"
           git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+
+      - name: Install Helm
+        uses: azure/setup-helm@v1
+        with:
+          version: v3.4.0
+
       - env:
           CR_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CR_RELEASE_NAME_TEMPLATE: "cluster-autoscaler-chart-{{ .Version }}"
         name: Run chart-releaser
-        uses: helm/chart-releaser-action@v1.0.0-rc.2
+        uses: helm/chart-releaser-action@v1.1.0
 name: Release Charts
 on:
   push:

charts/cluster-autoscaler-chart/Chart.yaml → charts/cluster-autoscaler/Chart.yaml

@@ -13,8 +13,8 @@ maintainers:
     name: gjtempleton
   - email: scott.crooks@gmail.com
     name: sc250024
-name: cluster-autoscaler-chart
+name: cluster-autoscaler
 sources:
   - https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler
 type: application
-version: 1.1.1
+version: 9.0.0

charts/cluster-autoscaler-chart/README.md → charts/cluster-autoscaler/README.md

@@ -1,4 +1,4 @@
-# cluster-autoscaler-chart
+# cluster-autoscaler
 
 Scales Kubernetes worker nodes within autoscaling groups.
 
@@ -8,11 +8,11 @@ Scales Kubernetes worker nodes within autoscaling groups.
 $ helm repo add autoscaler https://kubernetes.github.io/autoscaler
 
 # Method 1 - Using Autodiscovery
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set 'autoDiscovery.clusterName'=<CLUSTER NAME>
 
 # Method 2 - Specifying groups manually
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set "autoscalingGroups[0].name=your-asg-name" \
 --set "autoscalingGroups[0].maxSize=10" \
 --set "autoscalingGroups[0].minSize=1"
@@ -35,7 +35,16 @@ This chart bootstraps a cluster-autoscaler deployment on a [Kubernetes](http://k
 The previous `cluster-autoscaler` Helm chart hosted at [helm/charts](https://github.com/helm/charts) has been moved to this repository in accordance with the [Deprecation timeline](https://github.com/helm/charts#deprecation-timeline). Note that a few things have changed between this version and the old version:
 
 - This repository **only** supports Helm chart installations using Helm 3+ since the `apiVersion` on the charts has been marked as `v2`.
-- Previous versions of the Helm chart have not been migrated, and the version was reset to `1.0.0` at the onset. If you are looking for old versions of the chart, it's best to run `helm pull stable/cluster-autoscaler --version <your-version>` until you are ready to move to this repository's version.
+- Previous versions of the Helm chart have not been migrated, and the version was reset to `1.0.0` initially. If you are looking for old versions of the chart, it's best to run `helm pull stable/cluster-autoscaler --version <your-version>` until you are ready to move to this repository's version.
+- The previous versioning scheme has been returned to as of version `9.0.0` for ease of migration from the previous chart location.
+
+## Migration from 1.X to 9.X+ versions of this Chart
+
+On initial adoption of this chart this chart was renamed from `cluster-autoscaler` to `cluster-autoscaler-chart` due to technical limitations. This affects all `1.X` releases of the chart.
+
+Releases of the chart from `9.0.0` onwards return the naming of the chart to `cluster-autoscaler` and return to following the versioning established by the chart's previous location.
+
+To migrate from a 1.X release of the chart to a `9.0.0` or later release, you should first uninstall your `1.X` install of the `cluster-autoscaler-chart` chart, before performing the installation of the new `cluster-autoscaler` chart.
 
 ## Installing the Chart
 
@@ -66,7 +75,7 @@ Auto-discovery finds ASGs tags as below and automatically manages them based on
 - Set `awsAccessKeyID=<YOUR AWS KEY ID>` and `awsSecretAccessKey=<YOUR AWS SECRET KEY>` if you want to [use AWS credentials directly instead of an instance role](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md#using-aws-credentials)
 
 ```console
-$ helm install my-release autoscaler/cluster-autoscaler-chart --set autoDiscovery.clusterName=<CLUSTER NAME>
+$ helm install my-release autoscaler/cluster-autoscaler --set autoDiscovery.clusterName=<CLUSTER NAME>
 ```
 
 #### Specifying groups manually
@@ -77,7 +86,7 @@ Without autodiscovery, specify an array of elements each containing ASG name, mi
 - Either provide a yaml file setting `autoscalingGroups` (see values.yaml) or use `--set` e.g.:
 
 ```console
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set "autoscalingGroups[0].name=your-asg-name" \
 --set "autoscalingGroups[0].maxSize=10" \
 --set "autoscalingGroups[0].minSize=1"
@@ -138,7 +147,7 @@ The following parameters are required:
 To use Managed Instance Group (MIG) auto-discovery, provide a YAML file setting `autoscalingGroupsnamePrefix` (see values.yaml) or use `--set` when installing the Chart - e.g.
 
 ```console
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set "autoscalingGroupsnamePrefix[0].name=your-ig-prefix,autoscalingGroupsnamePrefix[0].maxSize=10,autoscalingGroupsnamePrefi[0].minSize=1" \
 --set autoDiscovery.clusterName=<CLUSTER NAME> \
 --set cloudProvider=gce
@@ -183,7 +192,7 @@ Example values files can be found [here](../../cluster-autoscaler/cloudprovider/
 Install the chart with
 
 ```
-$ helm install my-release autoscaler/cluster-autoscaler-chart -f myvalues.yaml
+$ helm install my-release autoscaler/cluster-autoscaler -f myvalues.yaml
 ```
 
 ## Uninstalling the Chart

charts/cluster-autoscaler-chart/README.md.gotmpl → charts/cluster-autoscaler/README.md.gotmpl

@@ -8,11 +8,11 @@
 $ helm repo add autoscaler https://kubernetes.github.io/autoscaler
 
 # Method 1 - Using Autodiscovery
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set 'autoDiscovery.clusterName'=<CLUSTER NAME>
 
 # Method 2 - Specifying groups manually
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set "autoscalingGroups[0].name=your-asg-name" \
 --set "autoscalingGroups[0].maxSize=10" \
 --set "autoscalingGroups[0].minSize=1"
@@ -35,7 +35,16 @@ This chart bootstraps a cluster-autoscaler deployment on a [Kubernetes](http://k
 The previous `cluster-autoscaler` Helm chart hosted at [helm/charts](https://github.com/helm/charts) has been moved to this repository in accordance with the [Deprecation timeline](https://github.com/helm/charts#deprecation-timeline). Note that a few things have changed between this version and the old version:
 
 - This repository **only** supports Helm chart installations using Helm 3+ since the `apiVersion` on the charts has been marked as `v2`.
-- Previous versions of the Helm chart have not been migrated, and the version was reset to `1.0.0` at the onset. If you are looking for old versions of the chart, it's best to run `helm pull stable/cluster-autoscaler --version <your-version>` until you are ready to move to this repository's version.
+- Previous versions of the Helm chart have not been migrated, and the version was reset to `1.0.0` initially. If you are looking for old versions of the chart, it's best to run `helm pull stable/cluster-autoscaler --version <your-version>` until you are ready to move to this repository's version.
+- The previous versioning scheme has been returned to as of version `9.0.0` for ease of migration from the previous chart location.
+
+## Migration from 1.X to 9.X+ versions of this Chart
+
+On initial adoption of this chart this chart was renamed from `cluster-autoscaler` to `cluster-autoscaler-chart` due to technical limitations. This affects all `1.X` releases of the chart.
+
+Releases of the chart from `9.0.0` onwards return the naming of the chart to `cluster-autoscaler` and return to following the versioning established by the chart's previous location.
+
+To migrate from a 1.X release of the chart to a `9.0.0` or later release, you should first uninstall your `1.X` install of the `cluster-autoscaler-chart` chart, before performing the installation of the new `cluster-autoscaler` chart.
 
 ## Installing the Chart
 
@@ -66,7 +75,7 @@ Auto-discovery finds ASGs tags as below and automatically manages them based on
 - Set `awsAccessKeyID=<YOUR AWS KEY ID>` and `awsSecretAccessKey=<YOUR AWS SECRET KEY>` if you want to [use AWS credentials directly instead of an instance role](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/cloudprovider/aws/README.md#using-aws-credentials)
 
 ```console
-$ helm install my-release autoscaler/cluster-autoscaler-chart --set autoDiscovery.clusterName=<CLUSTER NAME>
+$ helm install my-release autoscaler/cluster-autoscaler --set autoDiscovery.clusterName=<CLUSTER NAME>
 ```
 
 #### Specifying groups manually
@@ -77,7 +86,7 @@ Without autodiscovery, specify an array of elements each containing ASG name, mi
 - Either provide a yaml file setting `autoscalingGroups` (see values.yaml) or use `--set` e.g.:
 
 ```console
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set "autoscalingGroups[0].name=your-asg-name" \
 --set "autoscalingGroups[0].maxSize=10" \
 --set "autoscalingGroups[0].minSize=1"
@@ -138,7 +147,7 @@ The following parameters are required:
 To use Managed Instance Group (MIG) auto-discovery, provide a YAML file setting `autoscalingGroupsnamePrefix` (see values.yaml) or use `--set` when installing the Chart - e.g.
 
 ```console
-$ helm install my-release autoscaler/cluster-autoscaler-chart \
+$ helm install my-release autoscaler/cluster-autoscaler \
 --set "autoscalingGroupsnamePrefix[0].name=your-ig-prefix,autoscalingGroupsnamePrefix[0].maxSize=10,autoscalingGroupsnamePrefi[0].minSize=1" \
 --set autoDiscovery.clusterName=<CLUSTER NAME> \
 --set cloudProvider=gce
@@ -183,7 +192,7 @@ Example values files can be found [here](../../cluster-autoscaler/cloudprovider/
 Install the chart with
 
 ```
-$ helm install my-release autoscaler/cluster-autoscaler-chart -f myvalues.yaml
+$ helm install my-release autoscaler/cluster-autoscaler -f myvalues.yaml
 ```
 
 ## Uninstalling the Chart