Merge pull request #11737 from hashicorp/ap/ap-rename

This commit is contained in:
Freddy 2021-12-03 18:02:10 -07:00 committed by GitHub
commit ddb151aa7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 17 deletions

3
.changelog/11737.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:improvement
partitions: **(Enterprise only)** rename APIs, commands, and public types to use "partition" rather than "admin partition".
```

View File

@ -6,13 +6,13 @@ import (
"time" "time"
) )
// AdminPartition is the configuration of a single admin partition. Admin Partitions are a Consul Enterprise feature. // Partition is the configuration of a single admin partition. Admin Partitions are a Consul Enterprise feature.
type AdminPartition struct { type Partition struct {
// Name is the name of the Partition. // Name is the name of the Partition.
Name string `json:"Name"` Name string `json:"Name"`
// Description is where the user puts any information they want // Description is where the user puts any information they want
// about the partition. It is not used internally. // about the admin partition. It is not used internally.
Description string `json:"Description,omitempty"` Description string `json:"Description,omitempty"`
// DeletedAt is the time when the Partition was marked for deletion // DeletedAt is the time when the Partition was marked for deletion
@ -29,11 +29,7 @@ type AdminPartition struct {
// PartitionDefaultName is the default partition value. // PartitionDefaultName is the default partition value.
const PartitionDefaultName = "default" const PartitionDefaultName = "default"
type AdminPartitions struct { // Partitions can be used to manage Partitions in Consul Enterprise.
Partitions []*AdminPartition
}
// Partitions can be used to manage Partitions in Consul Enterprise..
type Partitions struct { type Partitions struct {
c *Client c *Client
} }
@ -43,7 +39,7 @@ func (c *Client) Partitions() *Partitions {
return &Partitions{c} return &Partitions{c}
} }
func (p *Partitions) Create(ctx context.Context, partition *AdminPartition, q *WriteOptions) (*AdminPartition, *WriteMeta, error) { func (p *Partitions) Create(ctx context.Context, partition *Partition, q *WriteOptions) (*Partition, *WriteMeta, error) {
if partition.Name == "" { if partition.Name == "" {
return nil, nil, fmt.Errorf("Must specify a Name for Partition creation") return nil, nil, fmt.Errorf("Must specify a Name for Partition creation")
} }
@ -62,7 +58,7 @@ func (p *Partitions) Create(ctx context.Context, partition *AdminPartition, q *W
} }
wm := &WriteMeta{RequestTime: rtt} wm := &WriteMeta{RequestTime: rtt}
var out AdminPartition var out Partition
if err := decodeBody(resp, &out); err != nil { if err := decodeBody(resp, &out); err != nil {
return nil, nil, err return nil, nil, err
} }
@ -70,7 +66,7 @@ func (p *Partitions) Create(ctx context.Context, partition *AdminPartition, q *W
return &out, wm, nil return &out, wm, nil
} }
func (p *Partitions) Update(ctx context.Context, partition *AdminPartition, q *WriteOptions) (*AdminPartition, *WriteMeta, error) { func (p *Partitions) Update(ctx context.Context, partition *Partition, q *WriteOptions) (*Partition, *WriteMeta, error) {
if partition.Name == "" { if partition.Name == "" {
return nil, nil, fmt.Errorf("Must specify a Name for Partition updating") return nil, nil, fmt.Errorf("Must specify a Name for Partition updating")
} }
@ -89,7 +85,7 @@ func (p *Partitions) Update(ctx context.Context, partition *AdminPartition, q *W
} }
wm := &WriteMeta{RequestTime: rtt} wm := &WriteMeta{RequestTime: rtt}
var out AdminPartition var out Partition
if err := decodeBody(resp, &out); err != nil { if err := decodeBody(resp, &out); err != nil {
return nil, nil, err return nil, nil, err
} }
@ -97,8 +93,8 @@ func (p *Partitions) Update(ctx context.Context, partition *AdminPartition, q *W
return &out, wm, nil return &out, wm, nil
} }
func (p *Partitions) Read(ctx context.Context, name string, q *QueryOptions) (*AdminPartition, *QueryMeta, error) { func (p *Partitions) Read(ctx context.Context, name string, q *QueryOptions) (*Partition, *QueryMeta, error) {
var out AdminPartition var out Partition
r := p.c.newRequest("GET", "/v1/partition/"+name) r := p.c.newRequest("GET", "/v1/partition/"+name)
r.setQueryOptions(q) r.setQueryOptions(q)
r.ctx = ctx r.ctx = ctx
@ -143,8 +139,8 @@ func (p *Partitions) Delete(ctx context.Context, name string, q *WriteOptions) (
return wm, nil return wm, nil
} }
func (p *Partitions) List(ctx context.Context, q *QueryOptions) (*AdminPartitions, *QueryMeta, error) { func (p *Partitions) List(ctx context.Context, q *QueryOptions) ([]*Partition, *QueryMeta, error) {
var out *AdminPartitions var out []*Partition
r := p.c.newRequest("GET", "/v1/partitions") r := p.c.newRequest("GET", "/v1/partitions")
r.setQueryOptions(q) r.setQueryOptions(q)
r.ctx = ctx r.ctx = ctx

View File

@ -352,7 +352,7 @@ function run_tests {
start_consul secondary start_consul secondary
fi fi
if is_set $REQUIRE_PARTITIONS; then if is_set $REQUIRE_PARTITIONS; then
docker_consul "primary" admin-partition create -name ap1 > /dev/null docker_consul "primary" consul partition create -name ap1 > /dev/null
start_partitioned_client ap1 start_partitioned_client ap1
fi fi