Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into multiple-namespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
frouioui committed Mar 6, 2025
2 parents 5dd8ac2 + 2a9fe95 commit 199d147
Show file tree
Hide file tree
Showing 32 changed files with 842 additions and 408 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ compatible with certain Vitess and Kubernetes versions, as shown in this table:
| `v2.12.*` | `v19.0.*` | `v1.25.*`, `v1.26.*`, `v1.27.*`, or `v1.28.*` |
| `v2.13.*` | `v20.0.*` | `v1.25.*`, `v1.26.*`, `v1.27.*`, or `v1.28.*` |
| `v2.14.*` | `v21.0.*` | `v1.29.*`, `v1.30.*`, `v1.31.*` |
| `latest` | `latest` | `v1.29.*`, `v1.30.*`, `v1.31.*` |
| `latest` | `latest` | `v1.30.*`, `v1.31.*`, `v1.32.*` |

If for some reason you must attempt to use versions outside the recommend
window, we still welcome bug reports since a workaround might be possible.
Expand Down
2 changes: 1 addition & 1 deletion deploy/crds/planetscale.com_etcdlockservers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: etcdlockservers.planetscale.com
spec:
group: planetscale.com
Expand Down
2 changes: 1 addition & 1 deletion deploy/crds/planetscale.com_vitessbackups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: vitessbackups.planetscale.com
spec:
group: planetscale.com
Expand Down
10 changes: 7 additions & 3 deletions deploy/crds/planetscale.com_vitessbackupschedules.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: vitessbackupschedules.planetscale.com
spec:
group: planetscale.com
Expand Down Expand Up @@ -38,6 +38,7 @@ spec:
cluster:
type: string
concurrencyPolicy:
default: Forbid
enum:
- Allow
- Forbid
Expand Down Expand Up @@ -113,8 +114,6 @@ spec:
example: commerce
type: string
name:
enum:
- BackupShard
type: string
shard:
example: '-'
Expand Down Expand Up @@ -164,6 +163,11 @@ spec:
lastScheduledTime:
format: date-time
type: string
lastScheduledTimes:
additionalProperties:
format: date-time
type: string
type: object
type: object
type: object
served: true
Expand Down
2 changes: 1 addition & 1 deletion deploy/crds/planetscale.com_vitessbackupstorages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: vitessbackupstorages.planetscale.com
spec:
group: planetscale.com
Expand Down
2 changes: 1 addition & 1 deletion deploy/crds/planetscale.com_vitesscells.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: vitesscells.planetscale.com
spec:
group: planetscale.com
Expand Down
5 changes: 2 additions & 3 deletions deploy/crds/planetscale.com_vitessclusters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: vitessclusters.planetscale.com
spec:
group: planetscale.com
Expand Down Expand Up @@ -168,6 +168,7 @@ spec:
type: string
type: object
concurrencyPolicy:
default: Forbid
enum:
- Allow
- Forbid
Expand Down Expand Up @@ -239,8 +240,6 @@ spec:
example: commerce
type: string
name:
enum:
- BackupShard
type: string
shard:
example: '-'
Expand Down
2 changes: 1 addition & 1 deletion deploy/crds/planetscale.com_vitesskeyspaces.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: vitesskeyspaces.planetscale.com
spec:
group: planetscale.com
Expand Down
2 changes: 1 addition & 1 deletion deploy/crds/planetscale.com_vitessshards.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.16.1
controller-gen.kubebuilder.io/version: v0.17.2
name: vitessshards.planetscale.com
spec:
group: planetscale.com
Expand Down
49 changes: 27 additions & 22 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -647,16 +647,6 @@ SecretSource
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.BackupStrategyName">BackupStrategyName
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessBackupScheduleStrategy">VitessBackupScheduleStrategy</a>)
</p>
<p>
<p>BackupStrategyName describes the vtctldclient command that will be used to take a backup.
When scheduling a backup, you must specify at least one strategy.</p>
</p>
<h3 id="planetscale.com/v2.CephBackupLocation">CephBackupLocation
</h3>
<p>
Expand Down Expand Up @@ -2600,7 +2590,8 @@ The PullPolicy used will be the same as the one used to pull the vtctld image.</
</td>
<td>
<em>(Optional)</em>
<p>A list of pointers to currently running jobs.</p>
<p>A list of pointers to currently running jobs.
This field is deprecated and no longer used in versions &gt;= v2.15. It will be removed in a future release.</p>
</td>
</tr>
<tr>
Expand All @@ -2614,7 +2605,25 @@ Kubernetes meta/v1.Time
</td>
<td>
<em>(Optional)</em>
<p>Information when was the last time the job was successfully scheduled.</p>
<p>Information when was the last time the job was successfully scheduled.
This field is deprecated and no longer used in versions &gt;= v2.15. It will be removed in a future release.
Please use lastScheduledTimes instead which maps the last schedule time to each VitessBackupScheduleStrategy
in the VitessBackupSchedule.</p>
</td>
</tr>
<tr>
<td>
<code>lastScheduledTimes</code><br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#*k8s.io/apimachinery/pkg/apis/meta/v1.time--">
map[string]*k8s.io/apimachinery/pkg/apis/meta/v1.Time
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>A list of the last schedule we executed for each VitessBackupScheduleStrategy.
Note that these are not the times when the last execution started, only the scheduled times.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -2642,9 +2651,7 @@ command line that will be executed in the Job&rsquo;s pod.</p>
<td>
<code>name</code><br>
<em>
<a href="#planetscale.com/v2.BackupStrategyName">
BackupStrategyName
</a>
string
</em>
</td>
<td>
Expand Down Expand Up @@ -2741,11 +2748,9 @@ string
<td>
<p>Strategy defines how we are going to take a backup.
If you want to take several backups within the same schedule you can add more items
to the Strategy list. Each VitessBackupScheduleStrategy will be executed by the same
kubernetes job. This is useful if for instance you have one schedule, and you want to
take a backup of all shards in a keyspace and don&rsquo;t want to re-create a second schedule.
All the VitessBackupScheduleStrategy are concatenated into a single shell command that
is executed when the Job&rsquo;s container starts.</p>
to the Strategy list. Each VitessBackupScheduleStrategy will be executed within different
kubernetes jobs. This is useful if you want to have a single schedule backing up multiple shards
at the same time.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -2828,8 +2833,8 @@ ConcurrencyPolicy
<em>(Optional)</em>
<p>ConcurrencyPolicy specifies ho to treat concurrent executions of a Job.
Valid values are:
- &ldquo;Allow&rdquo; (default): allows CronJobs to run concurrently;
- &ldquo;Forbid&rdquo;: forbids concurrent runs, skipping next run if previous run hasn&rsquo;t finished yet;
- &ldquo;Allow&rdquo;: allows CronJobs to run concurrently;
- &ldquo;Forbid&rdquo; (default): forbids concurrent runs, skipping next run if previous run hasn&rsquo;t finished yet;
- &ldquo;Replace&rdquo;: cancels currently running job and replaces it with a new one.</p>
</td>
</tr>
Expand Down
49 changes: 27 additions & 22 deletions docs/api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -649,16 +649,6 @@ <h3 id="planetscale.com/v2.AzblobBackupLocation">AzblobBackupLocation
</tr>
</tbody>
</table>
<h3 id="planetscale.com/v2.BackupStrategyName">BackupStrategyName
(<code>string</code> alias)</p></h3>
<p>
(<em>Appears on:</em>
<a href="#planetscale.com/v2.VitessBackupScheduleStrategy">VitessBackupScheduleStrategy</a>)
</p>
<p>
<p>BackupStrategyName describes the vtctldclient command that will be used to take a backup.
When scheduling a backup, you must specify at least one strategy.</p>
</p>
<h3 id="planetscale.com/v2.CephBackupLocation">CephBackupLocation
</h3>
<p>
Expand Down Expand Up @@ -2602,7 +2592,8 @@ <h3 id="planetscale.com/v2.VitessBackupScheduleStatus">VitessBackupScheduleStatu
</td>
<td>
<em>(Optional)</em>
<p>A list of pointers to currently running jobs.</p>
<p>A list of pointers to currently running jobs.
This field is deprecated and no longer used in versions &gt;= v2.15. It will be removed in a future release.</p>
</td>
</tr>
<tr>
Expand All @@ -2616,7 +2607,25 @@ <h3 id="planetscale.com/v2.VitessBackupScheduleStatus">VitessBackupScheduleStatu
</td>
<td>
<em>(Optional)</em>
<p>Information when was the last time the job was successfully scheduled.</p>
<p>Information when was the last time the job was successfully scheduled.
This field is deprecated and no longer used in versions &gt;= v2.15. It will be removed in a future release.
Please use lastScheduledTimes instead which maps the last schedule time to each VitessBackupScheduleStrategy
in the VitessBackupSchedule.</p>
</td>
</tr>
<tr>
<td>
<code>lastScheduledTimes</code><br>
<em>
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#*k8s.io/apimachinery/pkg/apis/meta/v1.time--">
map[string]*k8s.io/apimachinery/pkg/apis/meta/v1.Time
</a>
</em>
</td>
<td>
<em>(Optional)</em>
<p>A list of the last schedule we executed for each VitessBackupScheduleStrategy.
Note that these are not the times when the last execution started, only the scheduled times.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -2644,9 +2653,7 @@ <h3 id="planetscale.com/v2.VitessBackupScheduleStrategy">VitessBackupScheduleStr
<td>
<code>name</code><br>
<em>
<a href="#planetscale.com/v2.BackupStrategyName">
BackupStrategyName
</a>
string
</em>
</td>
<td>
Expand Down Expand Up @@ -2743,11 +2750,9 @@ <h3 id="planetscale.com/v2.VitessBackupScheduleTemplate">VitessBackupScheduleTem
<td>
<p>Strategy defines how we are going to take a backup.
If you want to take several backups within the same schedule you can add more items
to the Strategy list. Each VitessBackupScheduleStrategy will be executed by the same
kubernetes job. This is useful if for instance you have one schedule, and you want to
take a backup of all shards in a keyspace and don&rsquo;t want to re-create a second schedule.
All the VitessBackupScheduleStrategy are concatenated into a single shell command that
is executed when the Job&rsquo;s container starts.</p>
to the Strategy list. Each VitessBackupScheduleStrategy will be executed within different
kubernetes jobs. This is useful if you want to have a single schedule backing up multiple shards
at the same time.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -2830,8 +2835,8 @@ <h3 id="planetscale.com/v2.VitessBackupScheduleTemplate">VitessBackupScheduleTem
<em>(Optional)</em>
<p>ConcurrencyPolicy specifies ho to treat concurrent executions of a Job.
Valid values are:
- &ldquo;Allow&rdquo; (default): allows CronJobs to run concurrently;
- &ldquo;Forbid&rdquo;: forbids concurrent runs, skipping next run if previous run hasn&rsquo;t finished yet;
- &ldquo;Allow&rdquo;: allows CronJobs to run concurrently;
- &ldquo;Forbid&rdquo; (default): forbids concurrent runs, skipping next run if previous run hasn&rsquo;t finished yet;
- &ldquo;Replace&rdquo;: cancels currently running job and replaces it with a new one.</p>
</td>
</tr>
Expand Down
Loading

0 comments on commit 199d147

Please sign in to comment.