Merge pull request #30 from d-kuro/d-kuro/v0.0.1

release v0.0.1

Author: d-kuro

README.md

@@ -1,12 +1,15 @@
 # scheduled-pod-autoscaler
 
-[![PkgGoDev](https://pkg.go.dev/badge/d-kuro/scheduled-pod-autoscaler)](https://pkg.go.dev/d-kuro/scheduled-pod-autoscaler) ![](https://github.com/d-kuro/scheduled-pod-autoscaler/workflows/main/badge.svg)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/d-kuro/scheduled-pod-autoscaler)](https://pkg.go.dev/github.com/d-kuro/scheduled-pod-autoscaler) ![](https://github.com/d-kuro/scheduled-pod-autoscaler/workflows/main/badge.svg)
 
-**Work in Progress** GitOps Native Schedule Scaling of Kubernetes Resources.
+Custom Kubernetes controller for GitOps native scheduled scaling.
+
+Autoscaling with `HorizontalPodAutoscaler` is difficult to use for spike access etc.
+`ScheduledPodAutoscaler` can for more flexible autoscaling by controlling min/max replicas at specific times.
 
 ## Overview
 
-scheduled-pod-autoscaler is made up of two custom resources.
+`ScheduledPodAutoscaler` is made up of two custom resources.
 
 The parent-child relationship can look like this:
 
@@ -22,7 +25,7 @@ default    └─Schedule/test-3                -              6m4s
 
 ### ScheduledPodAutoscaler
 
-`ScheduledPodAutoscaler` is a custom resource that wraps `HorizontalPodAutoscaler`.  
+`ScheduledPodAutoscaler` is a custom resource that wraps `HorizontalPodAutoscaler`.
 The `ScheduledPodAutoscaler` Controller generates a `HorizontalPodAutoscaler` from this resource.
 
 The specs of the `HorizontalPodAutoscaler` defined here will be used when no scheduled scaling is taking place.
@@ -59,17 +62,23 @@ nginx   3         10        Available   6m52s
 
 ### Schedule
 
-`Schedule` is a custom resource for defining scheduled scaling.  
+`Schedule` is a custom resource for defining scheduled scaling.
 You can define multiple children's `Schedule` for the parent `ScheduledPodAutoscaler`.
 
 The `ScheduledPodAutoscaler` controller refers to the `Schedule` and
 rewrites `HorizontalPodAutoscaler` created by `ScheduledPodAutoscaler` when it is time for scheduled scaling.
-`HorizontalPodAutoscaler` is not managed in Git, so there is no diffs in GitOps.
+`HorizontalPodAutoscaler` is not managed in Git, so there are no diffs in GitOps.
 
 > 📝 Note: A case of schedule conflicts
 >
 > In case of a schedule conflict, using the maximum value of min/max replicas.
 
+> 📝 Note: Warm-up time
+>
+> The `ScheduledPodAutoscaler` controller only changes the min/max replica of `HorizontalPodAutoscaler`.
+> Launching the Pod will take some time.
+> Be sure to set a generous amount of time for scheduled scaling.
+
 ```console
 $ kubectl get schedule -o wide
 NAME     REFERENCE   TYPE      STARTTIME          ENDTIME            STARTDAYOFWEEK   ENDDAYOFWEEK   MINPODS   MAXPODS   STATUS      AGE
@@ -157,10 +166,10 @@ By default, it is installed in the `kube-system` namespace.
 
 ```console
 # Kubernetes 1.16+
-$ kubectl apply -f https://raw.githubusercontent.com/d-kuro/scheduled-pod-autoscaler/v0.0.1-rc.1/manifests/install/install.yaml
+$ kubectl apply -f https://raw.githubusercontent.com/d-kuro/scheduled-pod-autoscaler/v0.0.1/manifests/install/install.yaml
 
 # Kubernetes < 1.16
-$ kubectl apply -f https://raw.githubusercontent.com/d-kuro/scheduled-pod-autoscaler/v0.0.1-rc.1/manifests/install/legacy/install.yaml
+$ kubectl apply -f https://raw.githubusercontent.com/d-kuro/scheduled-pod-autoscaler/v0.0.1/manifests/install/legacy/install.yaml
 ```
 
 ### Kustomize
@@ -172,7 +181,7 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 
 resources:
-  - github.com/d-kuro/scheduled-pod-autoscaler/manifests/install?ref=v0.0.1-rc.1
+  - github.com/d-kuro/scheduled-pod-autoscaler/manifests/install?ref=v0.0.1
 ```
 
 ## Spec
@@ -216,26 +225,16 @@ The port of the metrics endpoint can be changed using the `metrics-addr` option.
 | `scheduled_pod_auroscaler_min_replicas` | gauge | Lower limit for the number of pods that can be set by the scheduled pod autoscaler |
 | `scheduled_pod_auroscaler_max_replicas` | gauge | Upper limit for the number of pods that can be set by the scheduled pod autoscaler |
 
-## Options
-
-```text
-Usage scheduled-pod-autoscaler:
-  -enable-leader-election
-    	Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager.
-  -kubeconfig string
-    	Paths to a kubeconfig. Only required if out-of-cluster.
-  -master --kubeconfig
-    	(Deprecated: switch to --kubeconfig) The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.
-  -metrics-addr string
-    	The address the metric endpoint binds to. (default ":8080")
-  -probe-addr string
-    	The address the liveness probe and readiness probe endpoints bind to. (default ":9090")
-  -zap-devel
-    	Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error)
-  -zap-encoder value
-    	Zap log encoding ('json' or 'console')
-  -zap-log-level value
-    	Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity
-  -zap-stacktrace-level value
-    	Zap Level at and above which stacktraces are captured (one of 'info', 'error').
-```
+## Controller Options
+
+| name | type | description |
+| - | - | - |
+| `--enable-leader-election` | bool | Enable leader election for controller manager. Enabling this will ensure there is only one active controller manager. |
+| `--metrics-addr` | string | The address the metric endpoint binds to. (default ":8080") |
+| `--probe-addr` | string | The address the liveness probe and readiness probe endpoints bind to. (default ":9090") |
+| `--zap-devel` | bool | Development Mode defaults(encoder=consoleEncoder,logLevel=Debug,stackTraceLevel=Warn). Production Mode defaults(encoder=jsonEncoder,logLevel=Info,stackTraceLevel=Error) |
+| `--zap-encoder` | value | Zap log encoding ('json' or 'console') |
+| `--zap-log-level` | value | Zap Level to configure the verbosity of logging. Can be one of 'debug', 'info', 'error', or any integer value > 0 which corresponds to custom debug levels of increasing verbosity |
+| `--zap-stacktrace-level` | value | Zap Level at and above which stacktraces are captured (one of 'info', 'error'). |
+| `--kubeconfig` | string | Paths to a kubeconfig. Only required if out-of-cluster. |
+| `--master` | string | (Deprecated: switch to --kubeconfig) The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster. |

manifests/deployment/scheduled-pod-autoscaler.yaml

@@ -17,7 +17,7 @@ spec:
             - /manager
           args:
             - --enable-leader-election
-          image: ghcr.io/d-kuro/scheduled-pod-autoscaler:v0.0.1-rc.1
+          image: ghcr.io/d-kuro/scheduled-pod-autoscaler:v0.0.1
           name: manager
           ports:
             - containerPort: 8080

manifests/install/install.yaml

@@ -768,7 +768,7 @@ spec:
         - --enable-leader-election
         command:
         - /manager
-        image: ghcr.io/d-kuro/scheduled-pod-autoscaler:v0.0.1-rc.1
+        image: ghcr.io/d-kuro/scheduled-pod-autoscaler:v0.0.1
         livenessProbe:
           httpGet:
             path: /healthz

manifests/install/legacy/install.yaml

@@ -770,7 +770,7 @@ spec:
         - --enable-leader-election
         command:
         - /manager
-        image: ghcr.io/d-kuro/scheduled-pod-autoscaler:v0.0.1-rc.1
+        image: ghcr.io/d-kuro/scheduled-pod-autoscaler:v0.0.1
         livenessProbe:
           httpGet:
             path: /healthz