Skip to content

Commit

Permalink
Update links to Rest API docs (#2432)
Browse files Browse the repository at this point in the history
  • Loading branch information
marians authored Dec 16, 2024
1 parent 6252afc commit c14918c
Show file tree
Hide file tree
Showing 26 changed files with 44 additions and 44 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Check the reference for the `--master-ha` flag.

### Via the REST API {#rest-api}

Check the [v5 cluster modification API reference](/api/#operation/modifyClusterV5)
Check the [v5 cluster modification API reference](https://giantswarm.github.io/api-spec/#operation/modifyClusterV5)
to find out how to convert a cluster programmatically using the Giant Swarm REST API.

### Via the Management API {#management-api}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ You can create clusters in several ways:

- In the [web interface]({{< relref "/vintage/platform-overview/web-interface/" >}}).
- In `gsctl` using the [`create cluster`]({{< relref "/vintage/use-the-api/gsctl/create-cluster" >}}) command with the appropriate details set in a [cluster definition]({{< relref "/vintage/use-the-api/gsctl/cluster-definition" >}}).
- Via the [Giant Swarm REST API](/api/#operation/addCluster).
- Via the [Giant Swarm REST API](https://giantswarm.github.io/api-spec/#operation/addCluster).

When inspecting details of such a cluster, or using the [`gsctl show cluster`]({{< relref "/vintage/use-the-api/gsctl/show-cluster" >}}) command, we display the list of availability zones used by the cluster.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,12 @@ with homogeneous worker nodes. To account for this need, we introduced a new API

Using the v5 API endpoints, you can

- [Create a new cluster supporting node pools](/api/#operation/addClusterV5)
- [Get node pools of a cluster](/api/#operation/getNodePools)
- [Create a new node pool](/api/#operation/addNodePool)
- [Modify a cluster](/api/#operation/modifyClusterV5)
- [Modify a node pool](/api/#operation/modifyNodePool)
- [Delete a node pool](/api/#operation/deleteNodePool)
- [Create a new cluster supporting node pools](https://giantswarm.github.io/api-spec/#operation/addClusterV5)
- [Get node pools of a cluster](https://giantswarm.github.io/api-spec/#operation/getNodePools)
- [Create a new node pool](https://giantswarm.github.io/api-spec/#operation/addNodePool)
- [Modify a cluster](https://giantswarm.github.io/api-spec/#operation/modifyClusterV5)
- [Modify a node pool](https://giantswarm.github.io/api-spec/#operation/modifyNodePool)
- [Delete a node pool](https://giantswarm.github.io/api-spec/#operation/deleteNodePool)

## Node pools and the cluster definition YAML format

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Details of the implementation differ between AWS and Azure.

## Get started

To create clusters in a new cloud provider account, you first need to provide the credentials to the organization you'd like to use for this purpose. You are free to create a new organization for this purpose if you like. Organizations can be created in the Giant Swarm web UI, or via the [Giant Swarm REST API](/api/#operation/addOrganization).
To create clusters in a new cloud provider account, you first need to provide the credentials to the organization you'd like to use for this purpose. You are free to create a new organization for this purpose if you like. Organizations can be created in the Giant Swarm web UI, or via the [Giant Swarm REST API](https://giantswarm.github.io/api-spec/#operation/addOrganization).

To prepare your credentials, either as AWS account roles or as an Azure service principle, please follow our specific guides:

Expand All @@ -75,7 +75,7 @@ You can then assign the credentials to your organization in several ways:

- In the Giant Swarm web UI via the organization details page
- In `gsctl` using the [`update organization set-credentials`]({{< relref "/vintage/use-the-api/gsctl/update-org-set-credentials" >}}) command
- Via the [Giant Swarm REST API](/api/#operation/addCredentials)
- Via the [Giant Swarm REST API](https://giantswarm.github.io/api-spec/#operation/addCredentials)

All workload clusters created for that organization will then use the credentials provided to the organization and will reside in the account/subscription associated with them.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -414,8 +414,8 @@ access to the Management API. However, for the time being, our web interface mak
By supplying a JSON body with the values you would like to set, the Giant Swarm REST API will
create a ConfigMap or Secret in the right format and wire it up correctly for you.

- [REST API App Configs reference](/api/#tag/app-configs) for adding configuration values
- [REST API App Secrets reference](/api/#tag/app-secrets) for adding secret values
- [REST API App Configs reference](https://giantswarm.github.io/api-spec/#tag/app-configs) for adding configuration values
- [REST API App Secrets reference](https://giantswarm.github.io/api-spec/#tag/app-secrets) for adding secret values

### Using the Management API {#management-api}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,8 @@ This CR needs to be created only once for each AWS Account. It can be then refer
## Further reading

- [Basics and Concepts: Multi Account Support]({{< relref "/vintage/advanced/infrastructure-management/multi-account" >}})
- [API: Set credentials](/api/#operation/addCredentials)
- [API: Set credentials](https://giantswarm.github.io/api-spec/#operation/addCredentials)
- [Giant Swarm Architecture]({{< relref "/vintage/platform-overview/cluster-management/vintage/aws" >}})
- [Giant Swarm REST API documentation](/api/)
- [Giant Swarm REST API documentation](https://giantswarm.github.io/api-spec/)
- [AWS Service Limits](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)
- [AWS Support Center](https://console.aws.amazon.com/support/home)
Original file line number Diff line number Diff line change
Expand Up @@ -277,9 +277,9 @@ organization. These clusters' resources will be created in your AWS account.

- [Basics and Concepts: Multi Account Support]({{< relref "/vintage/advanced/infrastructure-management/multi-account" >}})
- [gsctl Reference: `update organization set-credentials`]({{< relref "/vintage/use-the-api/gsctl/update-org-set-credentials" >}})
- [API: Set credentials](/api/#operation/addCredentials)
- [API: Set credentials](https://giantswarm.github.io/api-spec/#operation/addCredentials)
- [Giant Swarm Architecture]({{< relref "/vintage/platform-overview/cluster-management/vintage/aws" >}})
- [Giant Swarm REST API documentation](/api/)
- [Giant Swarm REST API documentation](https://giantswarm.github.io/api-spec/)
- [AWS Service Limits](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)
- [AWS Support Center](https://console.aws.amazon.com/support/home)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,8 @@ In workload clusters without autoscaling support, the number of Ingress Controll
- [`gsctl create cluster`]({{< relref "/vintage/use-the-api/gsctl/create-cluster" >}}): Creating a cluster
- [`gsctl scale cluster`]({{< relref "/vintage/use-the-api/gsctl/scale-cluster" >}}): Scaling a cluster
- [`gsctl show cluster`]({{< relref "/vintage/use-the-api/gsctl/show-cluster" >}}): Inspecting a cluster
- [API: Create cluster](/api/#operation/addCluster)
- [API: Modify cluster](/api/#operation/modifyCluster)
- [API: Get cluster details](/api/#operation/getCluster)
- [API: Get cluster status](/api/#operation/getClusterStatus)
- [API: Create cluster](https://giantswarm.github.io/api-spec/#operation/addCluster)
- [API: Modify cluster](https://giantswarm.github.io/api-spec/#operation/modifyCluster)
- [API: Get cluster details](https://giantswarm.github.io/api-spec/#operation/getCluster)
- [API: Get cluster status](https://giantswarm.github.io/api-spec/#operation/getClusterStatus)
- [Kubernetes autoscaler FAQ](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md)
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ You can interact with the Giant Swarm App Platform through creating App custom r

- [App CRD reference]({{< relref "/vintage/use-the-api/management-api/crd/apps.application.giantswarm.io.md" >}})
- [Web Interface Reference: The Giant Swarm App Platform]({{< relref "/vintage/platform-overview/web-interface/app-platform" >}})
- [Apps and App Configs in the API reference](/api/#tag/apps)
- [Apps and App Configs in the API reference](https://giantswarm.github.io/api-spec/#tag/apps)

Both our web interface and REST API are used to create (or update) a set of App Custom Resources on your Kubernetes management cluster.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Note that by default, our user interfaces upgrade to the next active workload cl

- In **kubectl-gs**, the [`update cluster`]({{< relref "/reference/kubectl-gs/update-cluster" >}})) command provides an optional flag `--release-version` which allows to specify the version to upgrade to.

- Alternatively, you can use the [Giant Swarm REST API](/api/#operation/modifyClusterV5) or the [Management API]({{< relref "/vintage/use-the-api/management-api" >}}) to trigger the upgrade. Please talk to your Account Engineer in case you have any questions regarding this.
- Alternatively, you can use the [Giant Swarm REST API](https://giantswarm.github.io/api-spec/#operation/modifyClusterV5) or the [Management API]({{< relref "/vintage/use-the-api/management-api" >}}) to trigger the upgrade. Please talk to your Account Engineer in case you have any questions regarding this.

## How upgrades work

Expand Down
8 changes: 4 additions & 4 deletions src/content/vintage/use-the-api/gsctl/cluster-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ workers:
- `owner`: Name of the owner organization.
- `name`: Friendly name of the cluster. If not specified, a name will be generated.
- `release_version`: Allows to select a specific release version. The value must be the semantic version number (SemVer) of an active release. To get information on all available releases, use the [`gsctl list releases`]({{< relref "/vintage/use-the-api/gsctl/list-releases" >}}) command.
- `availability_zones`: Number of availability zones to use for worker nodes (on AWS and Azure only). Both the default value and the maximum can be obtained via the [Info endpoint](/api/#operation/getInfo) of the Giant Swarm REST API.
- `availability_zones`: Number of availability zones to use for worker nodes (on AWS and Azure only). Both the default value and the maximum can be obtained via the [Info endpoint](https://giantswarm.github.io/api-spec/#operation/getInfo) of the Giant Swarm REST API.
- `workers`: Array of node definition objects describing each worker node. See below for possible keys. If not specified, the default number of worker nodes with default settings will be created.

#### Node definition keys {#node-keys}
Expand Down Expand Up @@ -218,6 +218,6 @@ Chances are that you already work with YAML in various places. If not, here are
- [`gsctl create cluster`]({{< relref "/vintage/use-the-api/gsctl/create-cluster" >}}): Create a cluster based on flags, or a definition file
- [`gsctl create nodepool`]({{< relref "/vintage/use-the-api/gsctl/create-nodepool" >}})
- [`gsctl list releases`]({{< relref "/vintage/use-the-api/gsctl/list-releases" >}}): Listing available releases
- [API: Create cluster (v4)](/api/#operation/addCluster)
- [API: Create cluster (v5)](/api/#operation/addClusterV5)
- [API: Create node pool](/api/#operation/addNodePool)
- [API: Create cluster (v4)](https://giantswarm.github.io/api-spec/#operation/addCluster)
- [API: Create cluster (v5)](https://giantswarm.github.io/api-spec/#operation/addClusterV5)
- [API: Create node pool](https://giantswarm.github.io/api-spec/#operation/addNodePool)
4 changes: 2 additions & 2 deletions src/content/vintage/use-the-api/gsctl/create-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,5 +113,5 @@ When requesting cluster creation with workload cluster release v{{% first_aws_no
- [`gsctl create kubeconfig`]({{< relref "/vintage/use-the-api/gsctl/create-kubeconfig" >}}) - Getting a key pair and enabling `kubectl` to access a cluster
- [`gsctl delete cluster`]({{< relref "/vintage/use-the-api/gsctl/delete-cluster" >}}) - Deleting a cluster
- [Basics: Cluster Size and Autoscaling]({{< relref "/vintage/getting-started/operations/autoscaling/cluster-size" >}})
- [API: Create cluster (v4)](/api/#operation/addCluster)
- [API: Create cluster (v5)](/api/#operation/addClusterV5)
- [API: Create cluster (v4)](https://giantswarm.github.io/api-spec/#operation/addCluster)
- [API: Create cluster (v5)](https://giantswarm.github.io/api-spec/#operation/addClusterV5)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/create-keypair.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@ __Warning:__ Setting `system:masters` as an organization means the user who uses

- [Creating workload cluster key pairs via the Management API]({{< relref "/vintage/use-the-api/management-api/wc-key-pairs" >}})
- [`gsctl create kubeconfig`]({{< relref "/vintage/use-the-api/gsctl/create-kubeconfig" >}}): Create a key pair and prepare your kubectl configuration to access the cluster.
- [Rest API: Create key pair](/api/#operation/addKeyPair)
- [Rest API: Create key pair](https://giantswarm.github.io/api-spec/#operation/addKeyPair)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/create-kubeconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,5 +226,5 @@ Passing flag `--output` with value `json` to `gsctl create kubeconfig` changes t
- [Creating workload cluster key pairs via the Management API]({{< relref "/vintage/use-the-api/management-api/wc-key-pairs" >}})
- [`gsctl create keypair`]({{< relref "/vintage/use-the-api/gsctl/create-keypair" >}}): Create and download a key pair
- [kubectl reference](https://kubernetes.io/docs/reference/kubectl/overview/)
- [API: Create key pair](/api/#operation/addKeyPair)
- [API: Create key pair](https://giantswarm.github.io/api-spec/#operation/addKeyPair)
- [Kubie](https://github.com/sbstp/kubie)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/delete-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ Passing flag `--output` with value `json` to `gsctl delete cluster` changes the

- [`gsctl scale cluster`]({{< relref "/vintage/use-the-api/gsctl/scale-cluster" >}})
- [`gsctl` reference overview]({{< relref "/vintage/use-the-api/gsctl" >}})
- [API: Delete cluster](/api/#operation/deleteCluster)
- [API: Delete cluster](https://giantswarm.github.io/api-spec/#operation/deleteCluster)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ Maximum workers per cluster: 20
## Related

- [`gsctl select endpoint`]({{< relref "/vintage/use-the-api/gsctl/select-endpoint" >}})
- [API: Get information on the installation](/api/#operation/getInfo)
- [API: Get information on the installation](https://giantswarm.github.io/api-spec/#operation/getInfo)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/list-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ Providing a small part of the column name is also accepted: `d`/`del`/`deleting`
- [`gsctl create cluster`]({{< relref "/vintage/use-the-api/gsctl/create-cluster" >}})
- [`gsctl scale cluster`]({{< relref "/vintage/use-the-api/gsctl/scale-cluster" >}})
- [`gsctl delete cluster`]({{< relref "/vintage/use-the-api/gsctl/delete-cluster" >}})
- [API: Get clusters](/api/#operation/getClusters)
- [API: Get clusters](https://giantswarm.github.io/api-spec/#operation/getClusters)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/list-keypairs.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ CREATED EXPIRES ID DESCRIPTION
- [`gsctl create keypair`]({{< relref "/vintage/use-the-api/gsctl/create-keypair" >}})
- [`gsctl create kubeconfig`]({{< relref "/vintage/use-the-api/gsctl/create-kubeconfig" >}})
- [Securing your cluster with RBAC and PSP]({{< relref "/vintage/getting-started/security" >}})
- [API: Get key pairs](/api/#operation/getKeyPairs)
- [API: Get key pairs](https://giantswarm.github.io/api-spec/#operation/getKeyPairs)
- [X.509 on Wikipedia](https://en.wikipedia.org/wiki/X.509)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/list-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,5 @@ Output details:

- [`gsctl create cluster`]({{< relref "/vintage/use-the-api/gsctl/create-cluster" >}})
- [`gsctl show cluster`]({{< relref "/vintage/use-the-api/gsctl/show-cluster" >}})
- [API: Get releases](/api/#operation/getReleases)
- [API: Get releases](https://giantswarm.github.io/api-spec/#operation/getReleases)
- [`kubectl gs get releases`]({{< relref "/reference/kubectl-gs/get-releases" >}})
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ gsctl login <email> -e <endpoint> -p <password>

## Related

- [API: Create auth token](/api/#operation/createAuthToken)
- [API: Create auth token](https://giantswarm.github.io/api-spec/#operation/createAuthToken)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/scale-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Use `gsctl scale cluster --help` for a additional (global) arguments.
- [`gsctl update nodepool`]({{< relref "/vintage/use-the-api/gsctl/update-nodepool" >}}): Among others, allows to scale a node pool
- [`gsctl delete cluster`]({{< relref "/vintage/use-the-api/gsctl/delete-cluster" >}}): Delete a cluster
- [Basics: Cluster Size and Autoscaling]({{< relref "/vintage/getting-started/operations/autoscaling/cluster-size" >}})
- [API: Modify cluster](/api/#operation/modifyCluster)
- [API: Modify cluster](https://giantswarm.github.io/api-spec/#operation/modifyCluster)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/show-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ Note that some dynamic pieces of information, like the current number of workers
- [`gsctl list clusters`]({{< relref "/vintage/use-the-api/gsctl/list-clusters" >}})
- [`gsctl scale cluster`]({{< relref "/vintage/use-the-api/gsctl/scale-cluster" >}})
- [`gsctl delete cluster`]({{< relref "/vintage/use-the-api/gsctl/delete-cluster" >}})
- [API: Get cluster details](/api/#operation/getCluster)
- [API: Get cluster details](https://giantswarm.github.io/api-spec/#operation/getCluster)
6 changes: 3 additions & 3 deletions src/content/vintage/use-the-api/gsctl/update-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To remove a label, set its key to an empty string (`labeltodelete=`).

- [`gsctl create cluster`]({{< relref "/vintage/use-the-api/gsctl/create-cluster" >}}) - Add a node pool to a cluster
- [`gsctl list clusters`]({{< relref "/vintage/use-the-api/gsctl/list-clusters" >}}) - List all node pools of a cluster
- [API: Modify cluster (v4)](/api/#operation/modifyCluster)
- [API: Modify cluster (v5)](/api/#operation/modifyClusterV5)
- [API: Update cluster labels](/api/#operation/setClusterLabels)
- [API: Modify cluster (v4)](https://giantswarm.github.io/api-spec/#operation/modifyCluster)
- [API: Modify cluster (v5)](https://giantswarm.github.io/api-spec/#operation/modifyClusterV5)
- [API: Update cluster labels](https://giantswarm.github.io/api-spec/#operation/setClusterLabels)
- [Labelling workload clusters]({{< relref "/vintage/advanced/cluster-management/labelling-workload-clusters" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@ The flags mean:
- [Basics and Concepts: Multi-Account Support]({{< relref "/vintage/advanced/infrastructure-management/multi-account" >}})
- [Guides: Prepare an AWS account to run Giant Swarm workload clusters]({{< relref "/vintage/getting-started/cloud-provider-accounts/vintage/aws" >}})
- [Guides: Prepare an Azure subscription to run Giant Swarm workload clusters]({{< relref "/vintage/getting-started/cloud-provider-accounts/vintage/azure" >}})
- [API: Set credentials](/api/#operation/addCredentials)
- [API: Set credentials](https://giantswarm.github.io/api-spec/#operation/addCredentials)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/gsctl/upgrade-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ You can list available workload cluster releases with `gsctl list releases`.
- [`gsctl create cluster`]({{< relref "/vintage/use-the-api/gsctl/create-cluster" >}}): Reference for creating a cluster
- [`gsctl delete cluster`]({{< relref "/vintage/use-the-api/gsctl/delete-cluster" >}}): Reference for deleting a cluster
- [`gsctl list releases`]({{< relref "/vintage/use-the-api/gsctl/list-releases" >}}): Reference for listing available workload cluster releases
- [API: Upgrade cluster](/api/#operation/upgradeCluster)
- [API: Upgrade cluster](https://giantswarm.github.io/api-spec/#operation/upgradeCluster)
2 changes: 1 addition & 1 deletion src/content/vintage/use-the-api/rest-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ As of now, there is no termination date for the REST API. It is however **not av

## Further reading

- [REST API documentation](/api/)
- [REST API documentation](https://giantswarm.github.io/api-spec/)

0 comments on commit c14918c

Please sign in to comment.