Skip to content

Update changelog for release v0.5.0 #352

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

Closed
wants to merge 1 commit into from
Closed

Update changelog for release v0.5.0 #352

wants to merge 1 commit into from

Conversation

alxiord
Copy link

@alxiord alxiord commented Jun 15, 2018

No description provided.

acatangiu
acatangiu previously approved these changes Jun 15, 2018
CHANGELOG.md Outdated
* In case of failure, the metrics and the panic location are logged before aborting.
* A CPU features template for C3 is available, in addition to the one for T2.
* Seccomp filters restrict Firecracker from calling any other system calls than the minimum set it needs to function properly. The filters are enabled by setting the `USE_SECCOMP` environment variable to 1 before running Firecracker.
* Firecracker is started by a new binary called `jailer`. The jailer takes as command line arguments a unique ID, the path to the Firecracker binary, and a uid and gid for Firecracker to run as. It sets up a chroot environment and a cgroup and calls exec to morph into Firecracker.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: s/a unique ID/an unique ID

Copy link
Member

Choose a reason for hiding this comment

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

I think I would rephrase it to Firecracker can be started. We are not actually enforcing firecracker to be started by the jailer.

Copy link
Author

Choose a reason for hiding this comment

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

It's not a typo; phonetically, the word "unique" starts with a consonant as the letter "u" is pronounced "yu" (unlike "umbrella", for instance, where it's pronounced as a vowel). See http://www.writersdigest.com/online-editor/a-before-consonants-and-an-before-vowels-is-not-the-rule

Copy link
Author

Choose a reason for hiding this comment

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

Rephrased to "can be"

Copy link
Contributor

Choose a reason for hiding this comment

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

Schooled 🔥

CHANGELOG.md Outdated

* API requests, VCPU and device actions for the serial console (UART), keyboard (i8042), block and network devices are logged as metrics.
* Metrics are logged every 60 seconds.
* In case of failure, the metrics and the panic location are logged before aborting.
Copy link
Member

Choose a reason for hiding this comment

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

This should be in the Fixed section.

Copy link
Author

Choose a reason for hiding this comment

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

Moved

CHANGELOG.md Outdated
### Added

* API requests, VCPU and device actions for the serial console (UART), keyboard (i8042), block and network devices are logged as metrics.
* Metrics are logged every 60 seconds.
Copy link
Member

Choose a reason for hiding this comment

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

I would rephrase the previous 2 bullets as 1. Something that says: added a metrics system, added metrics for x, y, z. These metrics are logged every 60 seconds. We should have one bullet for one feature and these seem to both refer to the same thing.

Copy link
Author

Choose a reason for hiding this comment

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

Done

CHANGELOG.md Outdated

### Changed

* The metric implementation uses lockless operations on atomic variables.
Copy link
Member

Choose a reason for hiding this comment

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

This one is not customer facing, we should remove it.

Copy link
Author

Choose a reason for hiding this comment

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

Done

CHANGELOG.md Outdated

* The metric implementation uses lockless operations on atomic variables.
* Metric values are reset with every flush.
* Renamed `cpuid.rs` to `cpuid/mod.rs`.
Copy link
Member

Choose a reason for hiding this comment

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

All 3 entries related to cpuid (except renaming the CPUTemplate) are not customer facing and should not be in the changelog.

Copy link
Author

Choose a reason for hiding this comment

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

Removed.


### Removed

* Removed a leftover file generated by the logger unit tests.
Copy link
Member

Choose a reason for hiding this comment

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

We should also say that we removed firecracker-v0.1.0.yaml. The PR was just merged.

Copy link
Author

Choose a reason for hiding this comment

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

Done.

CHANGELOG.md Outdated
* Firecracker is started by a new binary called `jailer`. The jailer takes as command line arguments a unique ID, the path to the Firecracker binary, and a uid and gid for Firecracker to run as. It sets up a chroot environment and a cgroup and calls exec to morph into Firecracker.

### Changed

Copy link
Member

Choose a reason for hiding this comment

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

Just merged a PR that renames firecracker-beta.yaml to firecracker.yaml. This should be here somewhere.

Copy link
Author

Choose a reason for hiding this comment

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

Added a bullet for this change.

CHANGELOG.md Outdated
* In case of failure, the metrics and the panic location are logged before aborting.
* A CPU features template for C3 is available, in addition to the one for T2.
* Seccomp filters restrict Firecracker from calling any other system calls than the minimum set it needs to function properly. The filters are enabled by setting the `USE_SECCOMP` environment variable to 1 before running Firecracker.
* Firecracker is started by a new binary called `jailer`. The jailer takes as command line arguments a unique ID, the path to the Firecracker binary, and a uid and gid for Firecracker to run as. It sets up a chroot environment and a cgroup and calls exec to morph into Firecracker.
Copy link
Member

Choose a reason for hiding this comment

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

I think I would rephrase it to Firecracker can be started. We are not actually enforcing firecracker to be started by the jailer.

CHANGELOG.md Outdated
* Added metrics for API requests, VCPU and device actions for the serial console (UART), keyboard (i8042), block and network devices. Metrics are logged every 60 seconds.
* A CPU features template for C3 is available, in addition to the one for T2.
* Seccomp filters restrict Firecracker from calling any other system calls than the minimum set it needs to function properly. The filters are enabled by setting the `USE_SECCOMP` environment variable to 1 before running Firecracker.
* Firecracker can be started by a new binary called `jailer`. The jailer takes as command line arguments a unique ID, the path to the Firecracker binary, and a uid and gid for Firecracker to run as. It sets up a chroot environment and a cgroup and calls exec to morph into Firecracker.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should something follow after: to run as?

Copy link
Author

Choose a reason for hiding this comment

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

I meant to say that Firecracker will run as a process with the specified uid and gid, so no - but if it sounds weird, I'll change that.

Fixes #352

Signed-off-by: Alexandra Iordache <[email protected]>
@alxiord alxiord closed this in 149b917 Jun 15, 2018
@alxiord alxiord deleted the readme branch June 18, 2018 07:44
xibz pushed a commit to xibz/firecracker that referenced this pull request Dec 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants