Skip to content

Commit

Permalink
add release notes for 2.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
georg committed Jun 26, 2024
1 parent 43e04e7 commit 20098ae
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 42 deletions.
Binary file removed docs/_media/upgrade-cluster.jpg
Binary file not shown.
Binary file removed docs/guides/_media/onboarding-create-org.jpg
Binary file not shown.
Binary file removed docs/guides/_media/onboarding-create-space.jpg
Binary file not shown.
Binary file modified docs/guides/_media/ts-create.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/guides/_media/ts-helm.jpg
Binary file not shown.
Binary file removed docs/guides/_media/ts-rotate.jpg
Binary file not shown.
Binary file removed docs/guides/_media/ts-settings.jpg
Binary file not shown.
54 changes: 13 additions & 41 deletions docs/guides/teamspace-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,15 @@ Sign up or log in to the [Codezero Hub](https://hub.codezero.io). The onboarding

The Hub allows you to register and certify Teamspaces. This is also where you can invite and administer members of the Teamspace. While the Hub provides a graphical user interface equivalent to the `czctl` command line tool, all services either run on your local machine or in the Kubernetes cluster.

## Register a Teamspace on Hub
## Install Codezero in your Cluster

On the Profile menu, click on _Settings_ and then select _Teamspaces_. Click _Add Teamspace_ to name and register your Teamspace name.
On the Profile menu, click on _Settings_ and then select _Teamspaces_. Click _Add Teamspace_ to create the installation command.

![Teamspace Create](./_media/ts-create.jpg)

## Install Codezero in your Cluster

After registering your Teamspace you need to install the _Codezero System_ onto a Kubernetes cluster. Click on _Helm Install_ to copy the Helm install command. This install command is unique to your cluster. It includes a one-time token that is exchanged with the Hub to certify the Teamspace.

![Install Codezero](./_media/ts-helm.jpg)
This install command contains your organization's API key. Please keep it confidential.
It uses [Helm](https://helm.sh) to install the Codezero Space Agent. You can find the Helm charts on [GitHub](https://github.com/c6o/helm-charts).
Additional annotations may be necessary; refer to the section on Load balancer requirements below.

### Load balancer requirements

Expand All @@ -46,7 +44,6 @@ import TabItem from '@theme/TabItem';
service.beta.kubernetes.io/aws-load-balancer-scheme: "internet-facing"
```


</TabItem>
<TabItem value="gke" label="GKE" default>
Google Kubernetes Engine creates external Network Load Balancers by default.
Expand All @@ -56,8 +53,6 @@ import TabItem from '@theme/TabItem';
</TabItem>
</Tabs>



## Certification

The Codezero System installs into the `codezero` namespace and should take less than a minute to start depending on how long it takes to provision a LoadBalancer. Once ready, you should see the Certification column change to _Certified_ and shortly thereafter, you should see an IP address or Host Name show up under DNS. Your Teamspace is ready for use.
Expand All @@ -74,46 +69,23 @@ Codezero may be removed from the Kubernetes cluster at any time. It is recommend

To uninstall, run:

```bash
helm -n codezero uninstall codezero
```
```bash
helm -n codezero uninstall codezero
```

You can then go into the Hub and delete the Teamspace.

## Troubleshooting

### Rotate Certificate

Should you encounter any issues with the _Helm Install_, you cannot re-use the previously generated install string as the one-time token will have expired. To re-try, please:

1. Run `helm uninstall -n codezero codezero`
1. Select _Rotate Certificate_ from the commands menu
1. Click on _Helm Install_ link when it appears and try again

If you continue to encounter problems, please do not hesitate to reach out to us.

![Teamspace Install](./_media/ts-rotate.jpg)

### Upgrade Cluster / Codezero Space Agent

Occasionally a new Codezero release requires you to Update your Codezero Space Agent (also referred to as Upgrade your Cluster)

To update your Codezero Space Agent, follow these steps:

1. Log in to [Codezero Hub](https://hub.codezero.io).
2. Select your Teamspace in the top-left corner
3. Navigate to Settings > Teamspaces
4. Click the
<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-circle-arrow-up" width="24" height="24" viewBox="0 -2 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"></path>
<path d="M3 12a9 9 0 1 0 18 0a9 9 0 0 0 -18 0"></path><path d="M12 8l-4 4"></path>
<path d="M12 8v8"></path>
<path d="M16 12l-4 -4"></path>
</svg>
icon next to the version number of your Teamspace to copy the Helm upgrade command.
5. Run the command and then sign out and sign in again.

![Upgrade Space Agent](../_media/upgrade-cluster.jpg)
To update your Codezero Space Agent, run the following command:

```bash
helm repo add --force-update codezero https://charts.codezero.io && helm upgrade --namespace=codezero codezero codezero/codezero`
```

### Stuck _Waiting_ for DNS

Expand Down
7 changes: 7 additions & 0 deletions docs/references/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@ sidebar_position: 3
We have a regular 2 week release cadence.
NOTE: Please make sure that you update your Codezero Local Agent and Space Agent to the same version.

## 2.5.0 [2024-06-25]

* New Teamspace installation method to facilitate automated scripting of Teamspace deployments
* Fix namespace filter in Service Catalog
* Added security context to Router pods to satisfy [Restricted Pod Security policy](https://kubernetes.io/docs/concepts/security/pod-security-standards/#restricted)
* Bug fixes and security updates

## 2.4.0 [2024-06-11]

* Preview release of [Open Policy Agent integration](../guides/opa)
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ const config = {
lastVersion: "current",
versions: {
current: {
label: "v2.4",
label: "v2.5",
},
},
routeBasePath: "/",
Expand Down

0 comments on commit 20098ae

Please sign in to comment.