Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.8.0 #238

Merged
merged 2 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions charts/zora/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ name: zora
description: A multi-plugin solution that reports misconfigurations and vulnerabilities by scanning your cluster at scheduled times.
icon: https://zora-docs.undistro.io/v0.7/assets/logo.svg
type: application
version: 0.7.1-rc5
appVersion: "v0.7.1-rc5"
version: 0.8.0
appVersion: "v0.8.0"
sources:
- https://github.com/undistro/zora
4 changes: 2 additions & 2 deletions charts/zora/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Zora Helm Chart

+![Version: 0.7.1-rc5](https://img.shields.io/badge/Version-0.7.1--rc5-informational?style=flat-square&color=3CA9DD) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square&color=3CA9DD) ![AppVersion: v0.7.1-rc5](https://img.shields.io/badge/AppVersion-v0.7.1--rc5-informational?style=flat-square&color=3CA9DD)
![Version: 0.8.0](https://img.shields.io/badge/Version-0.8.0-informational?style=flat-square&color=3CA9DD) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square&color=3CA9DD) ![AppVersion: v0.8.0](https://img.shields.io/badge/AppVersion-v0.8.0-informational?style=flat-square&color=3CA9DD)

A multi-plugin solution that reports misconfigurations and vulnerabilities by scanning your cluster at scheduled times.

Expand All @@ -13,7 +13,7 @@ helm repo add undistro https://charts.undistro.io --force-update
helm repo update undistro
helm upgrade --install zora undistro/zora \
-n zora-system \
--version 0.7.1-rc5 \
--version 0.8.0 \
--create-namespace \
--wait \
--set clusterName="$(kubectl config current-context)"
Expand Down
2 changes: 1 addition & 1 deletion cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func main() {
flag.StringVar(&cronJobServiceAccount, "cronjob-serviceaccount-name", "zora-plugins", "Name of ServiceAccount to be configured, appended to ClusterRoleBinding and used by CronJobs")
flag.StringVar(&saasWorkspaceID, "saas-workspace-id", "", "Your workspace ID in Zora SaaS")
flag.StringVar(&saasServer, "saas-server", "http://localhost:3003", "Address for Zora's saas server")
flag.StringVar(&version, "version", "0.7.0", "Zora version")
flag.StringVar(&version, "version", "0.8.0", "Zora version")
flag.StringVar(&checksConfigMapNamespace, "checks-configmap-namespace", "zora-system", "Namespace of custom checks ConfigMap")
flag.StringVar(&checksConfigMapName, "checks-configmap-name", "zora-custom-checks", "Name of custom checks ConfigMap")
flag.StringVar(&kubexnsImage, "kubexns-image", "ghcr.io/undistro/kubexns:latest", "kubexns image")
Expand Down
4 changes: 2 additions & 2 deletions docs/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ as an additional parameter in Zora OSS installation command.
helm repo update undistro
helm upgrade --install zora undistro/zora \
-n zora-system \
--version 0.7.0 \
--version 0.8.0 \
--create-namespace \
--wait \
--set clusterName="$(kubectl config current-context)" \
Expand All @@ -46,7 +46,7 @@ as an additional parameter in Zora OSS installation command.
```shell hl_lines="7"
helm upgrade --install zora oci://ghcr.io/undistro/helm-charts/zora \
-n zora-system \
--version 0.7.0 \
--version 0.8.0 \
--create-namespace \
--wait \
--set clusterName="$(kubectl config current-context)" \
Expand Down
34 changes: 20 additions & 14 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Then, run the following command to install Zora [Helm chart](https://helm.sh/doc
helm repo update undistro
helm upgrade --install zora undistro/zora \
-n zora-system \
--version 0.7.0 \
--version 0.8.0 \
--create-namespace \
--wait \
--set clusterName="$(kubectl config current-context)"
Expand All @@ -42,7 +42,7 @@ Then, run the following command to install Zora [Helm chart](https://helm.sh/doc
```shell
helm upgrade --install zora oci://ghcr.io/undistro/helm-charts/zora \
-n zora-system \
--version 0.7.0 \
--version 0.8.0 \
--create-namespace \
--wait \
--set clusterName="$(kubectl config current-context)"
Expand Down Expand Up @@ -80,25 +80,31 @@ kubectl get misconfigurations -n zora-system
kubectl get vulnerabilities -n zora-system
```

## Migrating to 0.7
## Migrating to 0.8

### What's new in 0.7
### What's new in 0.8

In versions up to [0.6](/v0.6/), Zora was installed in a single cluster (referred to as the management cluster)
and connected to other clusters (referred to as target clusters) via kubeconfig, requiring only read permissions.
#### Extended Vulnerability Reports Information

Starting from version [0.7](/v0.7/), Zora should be installed in each cluster you want to scan.
This significant change, in addition to streamlining the quick start,
enables the use of plugins for more in-depth scans of your cluster,
thereby providing more insights to help you keep your cluster secure and adhere to best practices.
Now, `VulnerabilityReports` provide more in-depth information about the image, including `OS`, `architecture`, `distro`, and `digest`.
Additionally, details about vulnerabilities, such as `publishedDate` and `lastModifiedDate`, have been included
to offer a clearer understanding of your cluster's security posture.

#### Full Integration with Zora Dashboard

Zora 0.8 introduces the integration of Vulnerability Reports with the Zora Dashboard.
Now, alongside misconfigurations, you can centrally explore images and vulnerabilities across your clusters.

### Migration guide

The recommended way to migrate to version 0.7 is to [uninstall](#uninstall) Zora 0.6 from your management cluster,
including its CRDs, and then install it again on the clusters you wish to scan.
!!! warning "Version 0.7 or earlier"
If you are currently using a version prior to 0.7,
please be aware that the 0.7 release brought about significant architectural changes.
Before upgrading to version 0.8, refer to [this page](/v0.7/getting-started/installation/#migrating-to-07)
for essential information and considerations to ensure a smooth transition.


The ServiceAccounts in the target clusters, which previously contained the tokens used in the kubeconfig files,
will no longer be needed and can be deleted.
The recommended way to migrate to version 0.8 is to reinstall Zora, including its CRDs.

## Uninstall

Expand Down
4 changes: 0 additions & 4 deletions docs/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,6 @@ kubectl get misconfigurations
!!! note
The results are only available after a successful scan, in the same namespace as the `ClusterScan` (default is `zora-system`).

!!! note
Currently, vulnerability reports are only available in Zora OSS.
We are working to include this in Zora Dashboard, and it will be available soon.

## How plugins work

Starting from a `Plugin` and a `ClusterScan`, Zora manages and schedules scans by applying `CronJobs`, which
Expand Down
4 changes: 0 additions & 4 deletions docs/plugins/trivy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,3 @@ The `ClusterScan` will have a `Failed` status. You will see a log entry similar
```
2023-09-26T14:18:02Z ERROR worker failed to run worker {"error": "failed to create VulnerabilityReport \"kind-kind-usdockerpkgdevgooglesamplescontainersgkegbfrontendsha256dc8de8e0d569d2f828b187528c9317bd6b605c273ac5a282aebe471f630420fc-rzntw\": etcdserver: request is too large"}
```

!!! note
Currently, Trivy results (`VulnerabilityReport`) are only available in Zora OSS.
We are working to include this in Zora Dashboard, and it will be available soon.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ nav:
- Popeye: plugins/popeye.md
- Vulnerability:
- Trivy: plugins/trivy.md
- "🔄 Migrating to 0.7": getting-started/installation/#migrating-to-07
- "🔄 Migrating to 0.8": getting-started/installation/#migrating-to-08
# - "🔐 Data privacy": data-privacy.md
- "📊 Zora Dashboard": dashboard.md
# - "🗃️ Troubleshooting": troubleshooting.md
Expand Down
Loading