Skip to content

Commit

Permalink
doc: rename pcc in docs (#217)
Browse files Browse the repository at this point in the history
* doc: rename pcc in docs
  • Loading branch information
cbeti-ionos authored Apr 19, 2024
1 parent 4bb129b commit d905746
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 12 deletions.
8 changes: 4 additions & 4 deletions apis/compute/v1alpha1/privatecrossconnect_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ import (
xpv1 "github.com/crossplane/crossplane-runtime/apis/common/v1"
)

// PccParameters To connect two PrivateCrossconnects we need 2 lans defined, one in each Pcc.
// PccParameters To connect two Crossconnects we need 2 lans defined, one in each Pcc.
// After, we reference the Pcc through which we want the connection to be established.
type PccParameters struct {
// The name of the private cross-connection.
// The name of the cross-connection.
Name string `json:"name,omitempty"`
// A short description for the private cross-connection.
// A short description for the cross-connection.
Description string `json:"description,omitempty"`
}

// PccConfig is used by resources that need to link a Private Cross Connect via id or via reference.
// PccConfig is used by resources that need to link a Cross Connect via id or via reference.
type PccConfig struct {
// PrivateCrossConnectID is the ID of the Pcc on which the resource will be created.
// It needs to be provided via directly or via reference.
Expand Down
11 changes: 8 additions & 3 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [1.0.11] (TBD )
## [1.0.11] (April 2024)
- **Features**:
- Add `NLB` managed resources:
- `Network Load Balancer`
Expand All @@ -7,8 +7,13 @@

- **Fixes**:
- Changed fields for `CubeServer` CR:
- `cpuFamily` field has been removed as it prevented external resource creation.
- `template.name` is now immutable
- `cpuFamily` field has been removed as it prevented external resource creation.
- `template.name` is now immutable

- **Misc**:
- Added local registry usage example
- Changed e2e tests location to es/vit
- Renamed `Private Cross Connect` to `Cross Connect` in `pcc` documentation

## [1.0.10] (March 2024)
- **Features**:
Expand Down
4 changes: 2 additions & 2 deletions docs/api/compute-engine/pcc.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@ _Note_: The command should be run from the root of the `crossplane-provider-iono
In order to configure the IONOS Cloud Resource, the user can set the `spec.forProvider` fields into the specification file for the resource instance. The required fields that need to be set can be found [here](#required-properties). Following, there is a list of all the properties:

* `description` (string)
* description: A short description for the private cross-connection.
* description: A short description for the cross-connection.
* `name` (string)
* description: The name of the private cross-connection.
* description: The name of the cross-connection.

### Required Properties

Expand Down
6 changes: 3 additions & 3 deletions package/crds/compute.ionoscloud.crossplane.io_pccs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ spec:
type: string
forProvider:
description: |-
PccParameters To connect two PrivateCrossconnects we need 2 lans defined, one in each Pcc.
PccParameters To connect two Crossconnects we need 2 lans defined, one in each Pcc.
After, we reference the Pcc through which we want the connection to be established.
properties:
description:
description: A short description for the private cross-connection.
description: A short description for the cross-connection.
type: string
name:
description: The name of the private cross-connection.
description: The name of the cross-connection.
type: string
type: object
managementPolicies:
Expand Down

0 comments on commit d905746

Please sign in to comment.