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.

Sign up for GitHub

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

Jump to bottom

Update README.md #492

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #492

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 25 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# IMPORTANT #

As of 26 Sep 2022 I decided to postpone publishing further code changes to this repo until I reach my sustainability goals.
As of 26 Sep 2022, I decided to postpone publishing further code changes to this repo until I reach my sustainability goals.

Further changes will be closed source and only available to my Marketplace subscribers until further notice.

Expand Down Expand Up @@ -37,7 +37,7 @@ changes.

Often all it needs is just tagging them with `spot-enabled=true`, (in some cases
even that can be avoided), yielding the usual 70%-90% Spot cost
savings but in a better integrated and easier to adopt way
savings but in a better integrated and easier-to-adopt way
than other alternative tools and solutions.

It is particularly useful if you have a large footprint that you want to migrate
Expand All @@ -47,9 +47,9 @@ changes.
## Guiding principles ##

- Customer-focused, designed to maximize user benefits and reduce adoption friction
- Safe and secure, hosted in your AWS account and with minimal required set of IAM permissions
- Safe and secure, hosted in your AWS account and with the minimal required set of IAM permissions
- Auditable OSS code base developed in the open
- Inexpensive, easy to install and supported builds offered through the AWS Marketplace
- Inexpensive, easy to install, and supported builds offered through the AWS Marketplace
- Simple, minimalist implementation

## How does it work? ##
Expand All @@ -59,7 +59,7 @@ AutoScaling groups, AutoSpotting gradually replaces their on-demand instances
with cheaper spot instances that are at least as large and identically
configured to the group's members, without changing the group launch
configuration in any way. You can also keep running a configurable number of
on-demand instances given as percentage or absolute number and it automatically
on-demand instances given as a percentage or an absolute number and it automatically
fails over to on-demand in case of spot instance terminations.

Going forward, as well as on any new ASGs that match the expected tags, any new
Expand All @@ -75,7 +75,7 @@ default using a the
[capacity-optimized-prioritized](https://docs.amazonaws.cn/en_us/AWSEC2/latest/UserGuide/ec2-fleet-examples.html#ec2-fleet-config11)
allocation strategy, which is given a list of instance types sorted by price. This
configuration offers a good tradeoff between low cost and significantly reduced
interruption rates. The lowest-price allocation strategy is still available as a
interruption rates. The lowest-priced allocation strategy is still available as a
configuration option.

This process can partly be seen in action below, you can click to expand the animation:
Expand Down Expand Up @@ -105,16 +105,16 @@ configured in just a few minutes.
The stack uses the minimal set of IAM permissions required for them to
work and requires no admin-like cross-account permissions. The entire code base
can be audited to see how these permissions are being used and even locked down
further if your audit discovers any issues. **This is not a SaaS**, there's no
component that calls home or reveals any details about your infrastructure.
further if your audit discovers any issues. **This is not a SaaS**, no
component calls home or reveals any details about your infrastructure.

The main Lambda function is written in the Go programming language and the code
is compiled as a static binary. As of August 2021 this has been included in a
is compiled as a static binary. As of August 2021, this has been included in a
Docker image used by the Lambda function.

The stack also consists of a few CloudWatch event triggers, that run the Lambda
function periodically and whenever it needs to take action against the enabled
groups. Between runs your group is entirely managed by AutoScaling (including
groups. Between runs, your group is entirely managed by AutoScaling (including
any scaling policies you may have) and load balancer health checks, that can
trigger instance launches or replacements using the original on-demand launch
configuration.
Expand Down Expand Up @@ -144,10 +144,10 @@ where you want it enabled to `true`.
When installed from the AWS
[marketplace](https://aws.amazon.com/marketplace/pp/prodview-6uj4pruhgmun6), all
the required infrastructure and configuration will be created automatically, so
you can get started as fast as possible. Otherwise you'll need to build it
you can get started as fast as possible. Otherwise, you'll need to build it
yourself as per the instructions available [here](CUSTOM_BUILDS.md).

For more detailed information on how to get started you can also read this
For more detailed information on how to get started, you can also read this
[document](START.md)

## Support ##
Expand All @@ -158,12 +158,10 @@ will be prioritized.

Community support is available to OSS users on the
[gitter](https://gitter.im/cristim/autospotting) chat room, where the main
authors and other users are likely to help you solve issues. This is offered on
a best effort basis and under certain conditions, such as using the latest
version of the software available on the main Github branch, without any code
customizations and using the default configuration options.
authors and other users are likely to help you solve issues. This is offered on a best-effort basis and under certain conditions, such as using the latest version of the software available on the main GitHub branch, without any code
customizations, and using the default configuration options.

If you need help for a large scale rollout or migrating from alternative
If you need help with a large scale rollout or migrating from alternative
tools/solutions get in touch on [gitter](https://gitter.im/cristim).

## Contributing ##
Expand All @@ -172,26 +170,26 @@ AutoSpotting is fully open source and developed in the open by a vibrant
community of dozens of contributors.

If it helps you save any significant amount of money, it would be
greatly appreciated if you could support further development on [Github
greatly appreciated it if you could support further development on [Github
Sponsors](https://github.com/sponsors/cristim) or would purchase it from the AWS
[Marketplace](https://aws.amazon.com/marketplace/pp/prodview-6uj4pruhgmun6).

Note: Non-trivial code should be submitted according to the contribution
[guidelines](CONTRIBUTING.md). Individuals and companies supporting the
development of the open source code get free of charge support in getting their
development of the open source code get free-of-charge support in getting their
code merged upstream.

### Official binaries ###

The source code is and will always be open source, so you can build and run
it yourself, see how it works and even enhance it if you want.
it yourself, see how it works, and even enhance it if you want.

As of August 2021, fully functional, stable official binaries are only offered
through Docker images available on the AWS
[Marketplace](https://aws.amazon.com/marketplace/pp/prodview-6uj4pruhgmun6).

Evaluation binaries built from trunk after each commit and meant to help the
development process are also available from the Docker Hub but they expire after
Evaluation binaries are built from the trunk after each commit and meant to help the
development processes are also available from the Docker Hub but they expire after
a month since compilation.

Proven referrals towards a subscription to the Marketplace will be compensated
Expand All @@ -200,13 +198,13 @@ them on [gitter](https://gitter.im/cristim).

### Subscriptions ###

A free low traffic mailing list is available on <https://autospotting.io>, where
A free low-traffic mailing list is available on <https://autospotting.io>, where
you can sign up for occasional emails related to the project, mainly related to
major changes in the open source code, savings tips or announcements about other
major changes in the open source code, savings tips, or announcements about other
tools I've been working on.

Announcements on new Marketplace releases, including comprehensive release
notes, upgrade instructions and tips to get the most out of AutoSpotting will be
Announcements on new Marketplace releases, including the comprehensive release
notes, upgrade instructions, and tips to get the most out of AutoSpotting will be
communicated in private to Patreon
[subscribers](https://www.patreon.com/cristim/overview).

Expand All @@ -223,7 +221,7 @@ provide additional value to my community.
## Compiling and Installing ##

It is recommended to use the evaluation or stable Docker images available on the
AWS marketplace, which are easy to install, support further development of the
AWS marketplace, which is easy to install, supports further development of the
software and allow you to get some support.

But if you have some special needs that require some customizations or you don't
Expand Down