Skip to content

fix: doc for onprem 2.7 #1317

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
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
44 changes: 43 additions & 1 deletion _docs/whats-new/on-prem-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,56 @@ Welcome to the release notes for our on-premises releases.

## On-premises version 2.7

### Features & enhancements
### Installation & Upgrade

#### Installing v2.7
For detailed instructions on installing v2.7, visit [ArtifactHub](https://artifacthub.io/packages/helm/codefresh-onprem/codefresh){:target="\_blank"}.

#### Upgrading to v2.7
For details, see [Upgrade to 2.7 in ArtifactHub](https://artifacthub.io/packages/helm/codefresh-onprem/codefresh#to-2-7-0){:target="\_blank"}

**New indexes**
We added a new `feature-store-versioned` collection which requires **two new indexes** for good performance.
You must create the indexes listed below _**right after** upgrading_ to prevent disruption and avoid performance issues.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mikhail-klimko @masontikhonov
_**right after** upgrading_ is this right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be on a safe side I would say “before or right after”.

We could extend explanation to clarify that if created before upgrade, collection should be created first:

use codefresh;
db.createCollection('feature-store-versioned');


#### New indexes in v2.7

You must create the indexes listed below **right after upgrading** to prevent disruption and avoid performance issues.

##### createdAt_1

`createdAt_1` (db: `codefresh`; collection: `feature-store-versioned`)

* **Index details**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Index details**
* **Index keys**


```json
{
"createdAt" : 1
}
```
* **Index properties**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Index properties**
* **Index options**


```json
{
"expireAfterSeconds" : 43200
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mikhail-klimko @masontikhonov
I omitted the following properties (as it was done for indexes for other versions in our documentation):

{
    "v" : 2,
    "name" : "createdAt_1",
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is correct, the only option matter is expireAfterSeconds

```

##### LDRedisStoreVersion_1__id_-1

`LDRedisStoreVersion_1__id_-1` (db: `codefresh`; collection: `feature-store-versioned`)

* **Index details**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Index details**
* **Index keys**


```json
{
"LDRedisStoreVersion" : 1,
"_id" : -1
}
```


### Features & enhancements


#### General: Increased limit for audit logs
Expand Down