cloud-judge

README

Cloud-Judge

Overview

Cloud-Judge is a cloud-native online judging platform built on Kubernetes (k8s), designed for programming contests and algorithm challenges. It leverages the power of cloud computing to provide users with a scalable and highly available online coding environment. Cloud-Judge supports multiple programming languages, including but not limited to Java and Go, allowing developers to submit code in the cloud and receive immediate feedback and scoring.

Key Features

• Multi-Language Support: Supports a variety of programming languages, including Java and Go.
• Cloud-Native Architecture: Built on Kubernetes for high availability and elastic scaling.
• Real-Time Feedback: Provides immediate code evaluation results to help developers quickly identify issues.
• Security: Adheres to cloud security best practices to protect user data and code.
• Easy Integration: Offers a rich set of APIs for easy integration with other systems.

Description

Cloud-Judge is designed for coding enthusiasts and professional developers. It not only provides a stage to showcase programming skills but also serves as a powerful tool for educational and corporate training. Utilizing the capabilities of Kubernetes, Cloud-Judge can handle high-concurrency code submissions and evaluations while maintaining system stability and response speed.

Technical Highlights

• Containerized Deployment: All services run in Docker containers, managed by Kubernetes, ensuring consistent environments and rapid deployment.
• Auto-Scaling: Automatically adjusts resources based on load, optimizing cost and performance.
• Continuous Integration/Continuous Deployment (CI/CD): Integrated CI/CD processes support automated code building and deployment.
• Microservices Architecture: Designed with a microservices architecture for maintainability and scalability.

Getting Started

Prerequisites

• go version v1.22.0+
• docker version 17.03+.
• kubectl version v1.11.3+.
• Access to a Kubernetes v1.11.3+ cluster.

To Deploy on the cluster

Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/cloud-judge:tag

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/cloud-judge:tag

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Project Distribution

Following are the steps to build the installer and distribute this project to users.

1. Build the installer for the image built and published in the registry:

make build-installer IMG=<some-registry>/cloud-judge:tag

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

1. Using the installer

Users can just run kubectl apply -f to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/cloud-judge/<tag or branch>/dist/install.yaml

Contributing

// TODO(user): Add detailed information on how you would like others to contribute to this project

NOTE: Run make help for more information on all potential make targets

More information can be found via the Kubebuilder Documentation

License

Copyright 2024 coding-hui.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.