Skip to content

Commit

Permalink
misc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
nilsgstrabo committed Oct 1, 2024
1 parent 11d0779 commit 15cb4ad
Show file tree
Hide file tree
Showing 13 changed files with 38 additions and 64 deletions.
4 changes: 2 additions & 2 deletions public-site/docs/docs/topic-domain-names/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Domain names

There can be several domain names mapped to [application components](/start/radix-concepts/index.md#component) in Radix.

The domain names are composed of information from the application, and the [Radix cluster](../../start/radix-clusters/) where the application is hosted:
The domain names are composed with information from the application, and the [Radix cluster](../../start/radix-clusters/) where the application is hosted:

- `component-name`: The name of the component, e.g. `frontend`.
- `app-name`: The name of the application, e.g. `myapp`.
Expand Down Expand Up @@ -43,7 +43,7 @@ The _app default alias_ is a convenience domain name to make it easier to publis
Examples:

- `oneapp.app.radix.equinor.com`
- `theapp.app.c2.radix.equinor.com`
- `otherapp.app.c2.radix.equinor.com`
- `myapp.app.playground.radix.equinor.com`

## App alias
Expand Down
4 changes: 2 additions & 2 deletions public-site/docs/docs/topic-dynatrace-int/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ spec:
- DT_CONNECTION_POINT # formattedCommunicationEndpoints from response
```
After changing your `radixconfig.yaml` file and pushing the changes, you must log in to your Application Configuration page in [Web Console](https://console.radix.equinor.com) and paste in the PaaS-Token in **Private image hubs** under **App Secrets**.
Then you must update environment secrets in each component with corresponding Dynatrace configuration: `DT_TENANT`, `DT_TENANTTOKEN` (`tenantToken`) and `DT_CONNECTION_POINT` (`formattedCommunicationEndpoints`).
After changing your `radixconfig.yaml` file and pushing the changes, you must open the application's configuration page in [Web Console](https://console.radix.equinor.com) and paste in the PaaS-Token in **Private image hubs** under **App Secrets**.
You must then update environment secrets in each component with corresponding Dynatrace configuration: `DT_TENANT`, `DT_TENANTTOKEN` (`tenantToken`) and `DT_CONNECTION_POINT` (`formattedCommunicationEndpoints`).
```request
GET https://spa-equinor.kanari.com/e/<DT_TENANT>/api/v1/deployment/installer/agent/connectioninfo
accept: application/json
Expand Down
42 changes: 10 additions & 32 deletions public-site/docs/docs/topic-radix-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,57 +6,35 @@ title: Radix CLI

## Purpose

[Radix command line interface](https://github.com/equinor/radix-cli) is an application to execute commands for getting information, creating a Radix application or pipeline jobs, setting values of secrets, start and stop Radis components and other operations, described below. The Radix CLI, available for multiple platforms, it can be downloaded from the [GitHub repository](https://github.com/equinor/radix-cli/tags).
[Radix CLI](https://github.com/equinor/radix-cli) is an application to execute commands for getting information, creating a Radix application or pipeline jobs, setting values of secrets, start and stop Radis components and other operations, described below. The Radix CLI, available for multiple platforms, it can be downloaded from the [GitHub repository](https://github.com/equinor/radix-cli/releases).

## Use

The Radix CLI can be used on local PC, in CI workflow, in a docker container.
Radix CLI can be installed and run from your local PC, as a Docker container, or in CI workflows, like GitHub actions.

Commands can be executed for `platform` or `playground` cluster, specified by an option `--context` or `-c`. Example: `--context platform` or `-c playground`. When no context specified, `platform` is used.
Commands can be executed towards all Radix cluster, either by setting the `--context` flag when executing a command, or by configuring the default context. `platform` is used if no context is specified.

The default context can be changed
Set the default context:
```shell
rx set context --context playground
```
Check the current context
Check the current context:
```shell
rx get context
```

Only applications, permitted for users or Azure AD groups, where they are member of, are available to execute commands for.

The command `rx --version` or `rx -v` shows the version, installed on the PC.

To get debug information about request, sent by the Radix CLI prefix the command with set of environment variable `DEBUG`: `DEBUG=true rx get application -a your-app-name`

### Run on a local PC

Download a [version of a Radix CLI](https://github.com/equinor/radix-cli/tags) for a required platform, extract an executable binary from an archive and move it to a folder, where executables usually located on the PC (or it can remain the folder, from it can be run). Example for a Linux or Mac:

```shell
LATEST_VERSION=$(
curl --silent "https://api.github.com/repos/equinor/radix-cli/releases/latest" |
grep '"tag_name":' |
sed -E 's/.*"v([^"]+)".*/\1/'
)

rx_tar=radix-cli_${LATEST_VERSION}_Darwin_x86_64.tar.gz
curl -OL "https://github.com/equinor/radix-cli/releases/download/v${LATEST_VERSION}/${rx_tar}"
tar -xf ${rx_tar}

sudo mv rx /usr/local/bin/rx
rm ${rx_tar}
```
Install Radix CLI locally by following the installation instructions in the [Radix CLI GitHub repository](https://github.com/equinor/radix-cli#installation).

To start working with Radix CLI, first login to the cluster:
To start working with Radix CLI you must first login:
```shell
rx login
```
Follow the provided Microsoft sign in device login URL and enter the provided code.

On successful login - commands can be executed within your user permissions to the Radix.
After successful login, you can start executing commands.

To clean up the login data - logout from the Radix:
To clean up the login data, logout from the Radix:
```shell
rx logout
```
Expand Down Expand Up @@ -190,7 +168,7 @@ An option `job` of commands `create`, `get logs` is replaced with `pipeline-job`
```
:::info
This scale will persist after re-deployment, so remember to reset the component when you are finished.
After reset, scaled component gets replicas specified in the `radixconfig.yaml`, "1" if not specified, or set by [horizontal scaling](../../radix-config/index.md#horizontalscaling)
After reset, scaled component gets replicas specified in the [`radixconfig.yaml`](../../radix-config/index.md), "1" if not specified, or set by [`horizontal scaling`](../../radix-config/index.md#horizontalscaling)
:::
#### Manage components
* Set a value of a component secret (runtime secret)
Expand Down
4 changes: 2 additions & 2 deletions public-site/docs/docs/topic-uptime/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ The Radix Platform should be used when your team has chosen Radix as PaaS (Platf

| Cluster | Purpose | Upgrade | Support |
| ---------------------------- | ------------------------------------------- | :-------------: | :---------: |
| **Platform (North Europe)** | Products under development or in production | Every ~6 months | Yes |
| **Platform 2 (West Europe)** | Products under development or in production | Every ~6 months | Yes |
| **Platform (North Europe)** | Apps under development or in production | Every ~6 months | Yes |
| **Platform 2 (West Europe)** | Apps under development or in production | Every ~6 months | Yes |
| **Playground** | Testing and experimenting with Radix | | Best-effort |

### Support
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ When manually scaled a component, it will be persisted accross deployments. Clic

## Reset

*Reset* removes the manually configured replicas count and will use the number of replica to the number set in the [`radixconfig.yaml`](../../radix-config/index.md#replicas) for the *active deployment* or by [horizontal scaling](../../radix-config/index.md#horizontalscaling).
*Reset* removes the manually configured replica count and sets it to the value defined in [`replicas`](../../radix-config/index.md#replicas) or [`horizontalScaling`](../../radix-config/index.md#horizontalscaling) defined by the *active deployment*.

## Restarting

Expand Down
6 changes: 3 additions & 3 deletions public-site/docs/guides/deploy-only/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In the `radixconfig.yaml` above, there are two tagging strategies;

A dynamic tag in this context means that there is a new tag produced for every build, either referring to the release tag, or the commit sha (in the case above) or any other attributes that uniquely identifies what the image is produced from. The dynamic tag will give better control over what runs in the environment, and it also allows for promoting older deployments in case there is a need for a rollback.

A static tag will not permit radix to update an existing deployment by relying on changes to `imageTagName` to pull a new image. To force radix to pull a new image from the image-hub, the component must be restarted using the component page on the web-console or restart call to the [Radix API](https://api.radix.equinor.com/swaggerui/#/component/restartComponent) (the URL for Radix API depends on which [Radix cluster](../../start/radix-clusters/) is hosting the application) or [CLI](https://github.com/equinor/radix-cli). There is currently no log trace of components starting and stopping. If this is necessary, one may call `deploy-only` once on the application before `restart` on each component using static tags.
A static tag will not permit radix to update an existing deployment by relying on changes to [`imageTagName`](../../radix-config/index.md#imagetagname) to pull a new image. To force radix to pull a new image from the image-hub, the component must be restarted using the component page on the web-console or restart call to the [Radix API](https://api.radix.equinor.com/swaggerui/#/component/restartComponent) or [CLI](https://github.com/equinor/radix-cli). The URL for Radix API depends on which [Radix cluster](../../start/radix-clusters/) is hosting the application.

The second part of the `radixconfig.yaml` which distinguishes itself from a regular radix application is the [`privateImageHubs` property](/radix-config/index.md#privateimagehubs). In short, it will allow for the image produced outside of Radix to be pulled down to the Radix cluster.

Expand Down Expand Up @@ -122,7 +122,7 @@ Read about [how to connect GitHub actions and Azure](https://learn.microsoft.com

With the access token you can make calls to Radix API through either:

- Calling the API directly (ref **Radix API (Swagger UI** in the list of [Radix clusters](../../start/radix-clusters/)) by passing the bearer token (i.e. curl -X GET --header "Authorization: Bearer \$token")
- Calling the Radix API directly by passing the bearer token (i.e. curl -X GET --header "Authorization: Bearer \$token")
- Calling the API though functions in the [Radix CLI](https://github.com/equinor/radix-cli), which allows for simpler access to the API
- Calling the API through [Radix GitHub Actions](https://github.com/equinor/radix-github-actions). If you have opted for GitHub Actions as your CI tool, then calling the Radix API indirectly through the Radix CLI using the Radix GitHub Actions can be done. It allows for simpler access to the CLI in your action's workflow.

Expand Down Expand Up @@ -212,7 +212,7 @@ Disclaimer: Please seek advice elsewhere on whether GitHub Actions and/or GitHub

When a Radix application has multiple components and only one or some of them need to be deployed, an option `component` can be used to specify these components. Multiple components can be specified. Other components, if exist in the environment, will not be re-deployed, keeping their `commitID` and `gitTags`, environment variables, secrets, etc. Replicas of not deployed components will not be restarted on deployment.

Please look at [Radix CLI deploy command](/docs/topic-radix-cli/index.md#deploy-pipeline-job) for examples. The `component` option can also be used with [Radix GitHub action](https://github.com/equinor/radix-github-actions) and Radix API (refer to **Radix API (Swagger UI)** in [Radix cluster](../../start/radix-clusters/) for the correct Radix API URL).
Please look at [Radix CLI deploy command](/docs/topic-radix-cli/index.md#deploy-pipeline-job) for examples. The `component` option can also be used with [Radix GitHub action](https://github.com/equinor/radix-github-actions) and Radix API.

When deploy pipeline job has been run with `component` option, Radix console will indicate on pipeline job, deployment and environment pages which components were not deployed:

Expand Down
2 changes: 1 addition & 1 deletion public-site/docs/guides/pipeline-badge/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The URL for generating a badge is:
https://api.<cluster-dns-zone>/api/v1/applications/<app-name>/environments/<env-name>/buildstatus?pipeline=<pipeline-type>
```

where `app-name` is the name of the application, `env-name` is the name of the environment within the application, and `pipeline-type`(optional) is one of **build-deploy**(default), **deploy** or **promote**. Refer to **DNS Zone** in [Radix clusters](../../start/radix-clusters/) for the correct value of `cluster-dns-zone`
where `app-name` is the name of the application, `env-name` is the name of the environment within the application, and `pipeline-type`(optional) is one of **build-deploy**(default), **deploy** or **promote**. Refer to *DNS Zone* in [Radix clusters](../../start/radix-clusters/) to get the `cluster-dns-zone` value for the cluster where your application is hosted.

Requesting a badge for a non-existing application or environment, or for a pipeline type that hasn't been run yet, the badge returns with an **unknown** status.
![build-deploy unknown](./build-deploy-unknown.png "build-deploy unknown")
Expand Down
2 changes: 1 addition & 1 deletion public-site/docs/guides/resource-request/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,4 +116,4 @@ For modern application development in Kubernetes and in Radix it is preferred to

![horizontal-pod-autoscaling](./horizontal-pod-autoscaling.png)

For Radix this can easily be done through horizontal pod autoscaling in the [radixconfig.yaml](../../radix-config/index.md#horizontalscaling). It will scale up based on CPU load over time for containers of a component (higher than 80%). More information can be found at [kubernetes docs](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
For Radix this can easily be configured with [`horizontalScaling`](../../radix-config/index.md#horizontalscaling) in [`radixconfig.yaml`](../../radix-config/index.md). It can scale components up and down based on CPU and memory utilization of the containers. More information can be found at [kubernetes docs](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/)
4 changes: 2 additions & 2 deletions public-site/docs/radix-config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -1692,7 +1692,7 @@ spec:
component: frontend
```

As a convenience for nicer URLs, `dnsAppAlias` creates a DNS alias in the form of `<app-name>.app.<cluster-dns-zone>` (`<cluster-dns-zone>` depends on which [Radix cluster](../start/radix-clusters/) you use) for the specified environment and component.
As a convenience for nicer URLs, `dnsAppAlias` creates a DNS alias in the form of `<app-name>.app.<cluster-dns-zone>` (`<cluster-dns-zone>` depends on which [Radix cluster](../start/radix-clusters/) is hosting the application) for the specified environment and component.

In the example above, if the application is host in the **Platform (North Europe)** cluster, the component **frontend** in environment **prod** will be accessible from `myapp.app.radix.equinor.com`, in addition to automatically allocated [domain names](../docs/topic-domain-names/).

Expand All @@ -1706,7 +1706,7 @@ spec:
component: frontend
```

`dnsAlias` creates one or several DNS aliases in the form of `<alias>.<cluster-dns-zone>` (`<cluster-dns-zone>` depends on which [Radix cluster](../start/radix-clusters/) you use) for the specified environment and component. There are few reserved aliases which cannot be used:
`dnsAlias` creates one or several DNS aliases in the form of `<alias>.<cluster-dns-zone>` (`<cluster-dns-zone>` depends on which [Radix cluster](../start/radix-clusters/) is hosting the application) for the specified environment and component. There are few reserved aliases which cannot be used:

`www`, `app`, `api`, `console`, `webhook`, `playground`, `dev`, `grafana`, `prometheus`, `canary`, `cost-api`.

Expand Down
8 changes: 6 additions & 2 deletions public-site/docs/start/getting-access/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@ title: Getting access

## Getting access

Access to Radix is managed in Access IT. To get started, decide if you want to try the Playground cluster or go straight to the Platform clusters. You will have access to register, build, deploy and maintain applications in that cluster.
Access to Radix is managed in Access IT. To get started, decide if you want to try the Playground cluster or go straight to one of the Platform clusters. You will have access to register, build, deploy and maintain applications in that cluster.

- :circus_tent: **Playground cluster**: Request the role "[Radix Playground Users](https://accessit.equinor.com/Search/Search?term=Radix+Playground+Users+%28OMNIA+RADIX%29)"

- :100: **Platform clusters**: Request the role "[Radix Platform Users](https://accessit.equinor.com/Search/Search?term=Radix+Platform+Users+%28OMNIA+RADIX%29)"

When the request is approved, you can access the the clusters from the Web Console ([Playground](https://console.playground.radix.equinor.com/) or [Platform](https://console.radix.equinor.com/)) or [Radix CLI](../../docs/topic-radix-cli/).
When the request is approved, you can access the clusters using Radix Web Console, Radix API or [Radix CLI](../../docs/topic-radix-cli/).

You can register your app in Playground first, and then again in Platform; there is no special "migrate to platform" process. If you have questions, [speak with us on Slack](https://equinor.slack.com/messages/CBKM6N2JY) and we'll help.

:::tip
Refer to [Radix clusters](../radix-clusters/) for a list of available clusters.
:::
5 changes: 5 additions & 0 deletions public-site/docs/start/radix-clusters/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ Your application(s) will run in a *Kubernetes cluster*. Radix currently have thr
| **Playground** | North Europe | playground.radix.equinor.com | [Link](https://console.playground.radix.equinor.com) | [Link](https://api.playground.radix.equinor.com/swaggerui/) |


:::info Moving applications between clusters

Currently, there is no automated process of moving an application between clusters. To move an application, you must manually register it in the new cluster, run pipeline jobs to deploy the application, and reconfigure any secrets, workload identities, external DNS entries etc.

:::
Loading

0 comments on commit 15cb4ad

Please sign in to comment.