access-company / antikythera Goto Github PK

View Code? Open in Web Editor NEW

213.0 42.0 19.0 1.97 MB

Elixir framework to build your own in-house PaaS

License: Apache License 2.0

Elixir 99.91% HTML 0.03% Haml 0.05% Shell 0.02%

elixir erlang-otp web-server paas faas

antikythera's Introduction

Antikythera Framework

Antikythera is an Elixir framework to build your own in-house PaaS (Platform as a Service).

You can run multiple web services while managing only a single cluster of ErlangVM nodes. From the viewpoint of service developers antikythera provides FaaS(Function as a Service)-like development experiences.

Note: Antikythera is already used in production at ACCESS, though as an OSS, it is still in early development stage and missing many components. Please be aware of that, and stay tuned for further additions!

Features

As a platform for multiple services:
- Resource control for multi-service and multi-tenant use cases
- Automated deployment without affecting other running services
- Built-in logging, monitoring and configuration management
- Service-to-service communications without network overhead
As a web framework:
- HTTP request processing with arbitrary Elixir code with WebSocket support
- Domain-based routing for multiple services; path-based routing within single service
- CDN support for static contents, HAML template for dynamic web pages
As an asynchronous job executor:
- Built-in distributed job queues
- Running arbitrary Elixir code for each job

Basic architecture

We refer to each antikythera cluster as an "antikythera instance", and each web service running within an antikythera instance as a "gear".
- Antikythera Instance example: antikythera_instance_example
- Gear example: testgear
- These two projects are also used for antikythera's test.
Antikythera is heavily dependent on the power of ErlangVM.
- Antikythera is written in Elixir, and all gears must also be written in Elixir.
Multiple gears are co-located and executed within the same ErlangVMs of an antikythera instance.
- This type of co-location of multiple applications are sometimes referred to as "nano-services architecture".
- This way we can eliminate the infrastructure/operational cost for having multiple web application stacks.
- Also, inter-service communications in a micro-services architecture become gear-to-gear communications in this nano-services architecture. Unlike micro-services architecture, it doesn't require network roundtrip as all gears are running within a single ErlangVM, resulting in lower communication overhead.
- Although gears share the same computing resources, they are executed in an independent manner thanks to the Erlang's process model.
- Antikythera instance and its gears are all separate mix projects.
  - Developers of different gears can work on their own projects, independently.
  - Library dependencies are defined per-antikythera-instance, and all gears inherit those dependencies.

Getting Started

See our Getting Started guide!

Documentation

Contributing

We encourage you to contribute to antikythera! Please check out our Contributing Guide.

For both core and gear development, please make use of our Style Guide.

Copyright and License

Antikythera source code is licensed under the Apache License version 2.0.

antikythera's People

Contributors

Stargazers

Watchers

Forkers

renesugar ikeyasu anobuhisamasaki tentakano yvc74 mikalv ajerryguo wses-yoshida amasamitsuyakushiji amikechen ashigenorimogi2 sylph01 bidaya0 irista56 massivefermion 00mjk webclinic017 5l1v3r1

antikythera's Issues

Lacking guide to production environment deployment

https://hexdocs.pm/antikythera/development_environment.html

Development guides for antikythera exist but there lacks a guide for production deployments.

What cicd is needed to deploy?

How does the antikythera code get merged with the gears code in a docker image?

How does ACCESS deploy: VMs? Docker? Kubernetes?

What environmental variables and other settings are required?

Whould you tell us the url of documentation?

It seems that it haven't been existed the documentation to the indicated url by CONTRIBUTING.md 😃

Broken link to guide for gear developers

https://hexdocs.pm/antikythera/gear_developers/ on https://hexdocs.pm/antikythera/getting_started.html

Relaxing limitation of versions?

When I tried to compile antikythera_instance_example.
It brings following errors:

antikythera_instance_example% mix deps.get
** (Mix.Error) Incorrect Erlang/OTP version! required: '20.2.2', used: '20.3.4'
    (mix) lib/mix.ex:291: Mix.raise/1
    deps/antikythera/mix_common.exs:22: (module)
    (stdlib) erl_eval.erl:670: :erl_eval.do_apply/6
    (stdlib) erl_eval.erl:122: :erl_eval.exprs/5

Yeah, I use latest stable versions OTP 20.3.4 and Elixir 1.6.4.
It seems the program works correctly.

But personaly, to being used this product widely, I think it needs to relaxing limitation of versions.
I'm glad you to If you consider it.

Thanks.

Adding `SameSite` to `Antikythera.Http.SetCookie`

Rationale

Antikythera.Http.SetCookie lacks the option to set the SameSite attribute of Set-Cookie header, and now it is forced into using SameSite=Lax.
As my team and I came across a need to set the SameSite directive to SameSite=none (especially in combination with Antikythera.Session), I am raising this issue and proposing the addition of this functionality. This would also help gears that want to enforce SameSite=strict.

Proposed changes

Add same_site field to Antikythera.Http.SetCookie
- This will be an enum that takes either :lax, :strict, or :none
- Adding a field under the SetCookie module's field list and adding a type would do this
- I am ready to write up a patch for this change
Add an interface to Antikythera.Plug.Session.load/2
- When explicitly adding a Cookie entry, passing an optional argument to Antikythera.Conn.put_resp_cookie/4 can achieve this
- But when used in combination with Antikythera.Plug.Session.load/2 it is not trivial, so I would like advice on how to change this
  - As of right now, I am thinking of passing options under :set_cookie key, then passing this option to make_before_send/2 (this would add an argument and thus change the signature to make_before_send/3 ) so that it can be passed onto Antikythera.Conn.put_resp_cookie/4 (now called with only 3 arguments).

Relevant references

SameSite cookies - HTTP | MDN

Roadmap?

Hi antikythera team,

I investigating this project and was wondering if there is a roadmap or a list of things that the team wants to have.

The contribution guide mentions to use the mailing list, but there's no activity there so I hope using the issues tracker for discussions is fine.

Thanks

Use nomnoml for diagrams?

I redrew a diagram using nomnoml. I can draw more if wanted.

Original:

Nomnoml:

[Load Balancer | HTTPS and Websocket Traffic] -> 1..* [Erlang VM (per server) |

[antikythera core | 
Domain-based request routing
]->[gear_x]
[antikythera core]->[gear_y]

[gear_y] -- [<note> Gear-to-gear communication]
[gear_x] -- [<note> Gear-to-gear communication]
[antikythera core] -- [<note> More gears..]
]

[Load Balancer | HTTPS and Websocket Traffic] -> [<note> More Erlang vms]
[Erlang VM (per server)] <-> [<note> Inter-node communication for websockets and async jobs]

Useful sites: