spcl / spcl/serverless-benchmarks

Testing and deployment instructions for managed Kubernetes

Open
#203 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Python
Stars
199
Forks
105
PR merge metrics
No merged PRs in 30d

Description

Currently, we support OpenWhisk, and we plan to add support for Fission and Knative. For OpenWhisk, we have documentation for deploying it on Kind locally. In practice, SeBS users might want to deploy Kubernetes in the cloud, manually or by using managed k8s like AWS EKS and Azure AKS.

We shouldn't document deployment and create scripts like tools/openwhisk_preparation.py - these are very helpful but difficult to maintain. Instead, we should always refer to the most up-to-date documentation and tutorials from the given platform, and verify that our documentation on connecting to the platform is correct. The typical problems are setting up a connection to the control plane and ensuring storage works correctly (#202).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review tools/openwhisk_preparation.py and the existing OpenWhisk-on-Kind documentation, then compare the connection and storage guidance with current AWS EKS and Azure AKS platform documentation. Update the documentation to reference current platform tutorials and verify that control-plane connection and storage instructions work, without adding deployment scripts.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, azure, kubernetes, python
Domain
cloud, devops, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.