Skip to content

Commit

Permalink
Merge pull request #158 from weaveworks/chore/rename
Browse files Browse the repository at this point in the history
  • Loading branch information
jmickey authored Oct 22, 2021
2 parents ddca2ef + e0b2248 commit 3d09bf1
Show file tree
Hide file tree
Showing 92 changed files with 361 additions and 359 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ assignees: ''

**Environment:**

- reignite version:
- flintlock version:
- OS (e.g. from `/etc/os-release`):
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Feature enhancement request
about: Suggest an idea for reignite
about: Suggest an idea for flintlock
title: ''
labels: kind/feature
assigness: ''
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ jobs:
go-version: 1.16
- name: Build binaries
run: make build-release
- name: Store reignite binaries
- name: Store flintlock binaries
uses: actions/upload-artifact@v2
with:
name: reignite-binaries
name: flintlock-binaries
path: bin/*
retention-days: 1
release:
Expand All @@ -33,7 +33,7 @@ jobs:
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Download reignite binaries
- name: Download flintlock binaries
uses: actions/download-artifact@v2
with:
name: mccp-binaries
Expand All @@ -56,5 +56,5 @@ jobs:
fail_on_unmatched_files: true
body: ${{ env.RELEASE_NOTES }}
files: |
bin/reignited_amd64
bin/reignited_arm64
bin/flintlockd_amd64
bin/flintlockd_arm64
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

We highly value and encourage contributions from the community!

Reignite is [MPL-2.0 licensed](LICENSE) and accepts contributions via GitHub
Flintlock is [MPL-2.0 licensed](LICENSE) and accepts contributions via GitHub
Pull Requests.This document outlines some of the conventions on development
workflow, commit message formatting, contact points and other resources to make
it easier to get your contribution accepted.
Expand All @@ -15,18 +15,18 @@ If you have a feature suggestion or found a bug, head over to
[GitHub issues][issues] and see if there's an open issue matching your
description. If not feel free to open a new issue and add short description:

- In case of a bug, be sure to include the steps you performed and what Reignite responded so it's easy for others to reproduce
- In case of a bug, be sure to include the steps you performed and what Flintlock responded so it's easy for others to reproduce
- If you have a feature suggestion, describe it in moderate detail and include some potential uses you see for the feature.

We prioritize the features to be implemented based on their usefulness/popularity. Of course if you want to start contributing yourself, go ahead! We'll be more than happy to review your pull requests.

The maintainers will add the correct labels/milestones to the issue for you.

[issues]: https://github.com/weaveworks/reignite/issues
[issues]: https://github.com/weaveworks/flintlock/issues

### Contributing your code

The process to contribute code to Reignite is very straightforward.
The process to contribute code to Flintlock is very straightforward.

1. Go to the project on [GitHub][repo] and click the `Fork` button in the
top-right corner. This will create your own copy of the repository in your
Expand All @@ -39,7 +39,7 @@ The process to contribute code to Reignite is very straightforward.
This will show repositories in addition to branches.
5. From the `head repository` dropdown, select your forked repository. If you
made a new branch, select it in the `compare` dropdown. You should always
target `weaveworks/reignite` and `main` as the base repository and branch.
target `weaveworks/flintlock` and `main` as the base repository and branch.
6. With your changes visible, click `Create pull request`. Give it a short,
descriptive title and write a comment describing your changes. Click `Create
pull request`.
Expand All @@ -55,5 +55,5 @@ Actions][gha]) that will build the code and verify it compiles and passes all
tests successfully. If your changes didn't pass CI, you can click Details to go
and check why it happened. To integrate your changes, we require CI to pass.

[repo]: https://github.com/weaveworks/reignite
[gha]: https://github.com/weaveworks/reignite/actions
[repo]: https://github.com/weaveworks/flintlock
[gha]: https://github.com/weaveworks/flintlock/actions
2 changes: 2 additions & 0 deletions COPYRIGHT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Copyright 2021 Weaveworks, Inc. All Rights Reserved.
SPDX-License-Identifier: MPL-2.0
14 changes: 7 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
BUILD_DATE := $(shell date +%Y-%m-%dT%H:%M:%SZ)
GIT_COMMIT := $(shell git rev-parse --short HEAD)
VERSION := $(shell git describe --always --match "v*")
VERSION_PKG := github.com/weaveworks/reignite/internal/version
VERSION_PKG := github.com/weaveworks/flintlock/internal/version
OS := $(shell go env GOOS)
ARCH := $(shell go env GOARCH)
UNAME := $(shell uname -s)
Expand All @@ -14,7 +14,7 @@ BUF_VERSION := v0.43.2
REPO_ROOT := $(shell git rev-parse --show-toplevel)
BIN_DIR := bin
OUT_DIR := out
REIGNITED_CMD := cmd/reignited
FLINTLOCKD_CMD := cmd/flintlockd
TOOLS_DIR := hack/tools
TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
TOOLS_SHARE_DIR := $(TOOLS_DIR)/share
Expand Down Expand Up @@ -51,12 +51,12 @@ WIRE := $(TOOLS_BIN_DIR)/wire

.PHONY: build
build: $(BIN_DIR) ## Build the binaries
go build -o $(BIN_DIR)/reignited ./cmd/reignited
go build -o $(BIN_DIR)/flintlockd ./cmd/flintlockd

.PHONY: build-release
build-release: $(BIN_DIR) ## Build the release binaries
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -v -o $(BIN_DIR)/reignited_amd64 -ldflags "-X $(VERSION_PKG).Version=$(VERSION) -X $(VERSION_PKG).BuildDate=$(BUILD_DATE) -X $(VERSION_PKG).CommitHash=$(GIT_COMMIT)" ./cmd/reignited
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o $(BIN_DIR)/reignited_arm64 -ldflags "-X $(VERSION_PKG).Version=$(VERSION) -X $(VERSION_PKG).BuildDate=$(BUILD_DATE) -X $(VERSION_PKG).CommitHash=$(GIT_COMMIT)" ./cmd/reignited
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -v -o $(BIN_DIR)/flintlockd_amd64 -ldflags "-X $(VERSION_PKG).Version=$(VERSION) -X $(VERSION_PKG).BuildDate=$(BUILD_DATE) -X $(VERSION_PKG).CommitHash=$(GIT_COMMIT)" ./cmd/flintlockd
CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build -o $(BIN_DIR)/flintlockd_arm64 -ldflags "-X $(VERSION_PKG).Version=$(VERSION) -X $(VERSION_PKG).BuildDate=$(BUILD_DATE) -X $(VERSION_PKG).CommitHash=$(GIT_COMMIT)" ./cmd/flintlockd


##@ Generate
Expand All @@ -78,7 +78,7 @@ generate-proto: $(BUF) $(PROTOC_GEN_GO) $(PROTOC_GEN_GO_GRPC) $(PROTO_GEN_GRPC_G

.PHONY: generate-di ## Generate the dependency injection code
generate-di: $(WIRE)
$(WIRE) gen github.com/weaveworks/reignite/internal/inject
$(WIRE) gen github.com/weaveworks/flintlock/internal/inject

##@ Linting

Expand All @@ -95,7 +95,7 @@ test: ## Run unit tests

.PHONY: test-with-cov
test-with-cov: ## Run unit tests with coverage
go test -v -race -timeout 2m -p 1 -covermode=atomic -coverprofile=coverage.txt ./...
go test -v -race -timeout 2m -p 1 -covermode=atomic -coverprofile=coverage.txt ./...

.PHONY: test-e2e
test-e2e: ## Run e2e tests
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@

# 🆁🅴🅸🅶🅽🅸🆃🅴 - the microvm service
# Flintlock - Create and manage the lifecycle of MicroVMs, backed by containerd.

[![GitHub](https://img.shields.io/github/license/weaveworks/reignite)](https://img.shields.io/github/license/weaveworks/reignite)
[![codecov](https://codecov.io/gh/weaveworks/reignite/branch/main/graph/badge.svg?token=ZNPNRDI8Z0)](https://codecov.io/gh/weaveworks/reignite)
[![Go Report Card](https://goreportcard.com/badge/github.com/weaveworks/reignite)](https://goreportcard.com/report/github.com/weaveworks/reignite)
[![GitHub](https://img.shields.io/github/license/weaveworks/flintlock)](https://img.shields.io/github/license/weaveworks/flintlock)
[![codecov](https://codecov.io/gh/weaveworks/flintlock/branch/main/graph/badge.svg?token=ZNPNRDI8Z0)](https://codecov.io/gh/weaveworks/flintlock)
[![Go Report Card](https://goreportcard.com/badge/github.com/weaveworks/flintlock)](https://goreportcard.com/report/github.com/weaveworks/flintlock)

## What is regnite?

Reignite is a service for creating and managing the lifecycle of microVMs on a host machine. Initially we will be supporting [Firecracker](https://firecracker-microvm.github.io/).
Flintlock is a service for creating and managing the lifecycle of microVMs on a host machine. Initially we will be supporting [Firecracker](https://firecracker-microvm.github.io/).

The primary use case for reignite is to create microVMs on a bare-metal host where the microVMs will be used as nodes in a virtualized Kubernetes cluster. It is an essential part of [Liquid Metal](https://www.weave.works/blog/multi-cluster-kubernetes-on-microvms-for-bare-metal) and will ultimately be driven by Cluster API Provider Microvm (coming soon).
The primary use case for flintlock is to create microVMs on a bare-metal host where the microVMs will be used as nodes in a virtualized Kubernetes cluster. It is an essential part of [Liquid Metal](https://www.weave.works/blog/multi-cluster-kubernetes-on-microvms-for-bare-metal) and will ultimately be driven by Cluster API Provider Microvm (coming soon).

## Features

Expand All @@ -22,7 +22,7 @@ Using API requests (via gRPC or HTTP):

## Documentation

See our [getting started with reignite][quickstart] guide.
See our [getting started with flintlock][quickstart] guide.

## Contributing

Expand All @@ -33,11 +33,11 @@ Other interesting resources include:
* [The issue tracker][issues]
* [The list of milestones][milestones]
* [Architectural Decision Records (ADR)][adr]
* [Getting started with reignite][quickstart]
* [Getting started with flintlock][quickstart]

## Getting Help

If you have any questions about, feedback for or problems with reignite:
If you have any questions about, feedback for or problems with flintlock:

* [File an issue][issues].

Expand All @@ -51,7 +51,7 @@ Your feedback is always welcome!
[quickstart]: ./docs/quick-start.md
[contrib]: ./CONTRIBUTING.md
[coc]: ./CODE_OF_CONDUCT.md
[issues]: https://github.com/weaveworks/reignite/issues
[milestones]: https://github.com/weaveworks/reignite/milestones
[issues]: https://github.com/weaveworks/flintlock/issues
[milestones]: https://github.com/weaveworks/flintlock/milestones
[adr]: ./docs/adr
[license]: ./LICENSE
8 changes: 4 additions & 4 deletions Vagrantfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- mode: ruby -*-
# vi: set ft=ruby :

# Copyright The reignite Authors
# Copyright The flintlock Authors

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand All @@ -19,7 +19,7 @@ Vagrant.configure("2") do |config|
config.vm.box = "generic/ubuntu2004"

config.ssh.forward_agent = true
config.vm.synced_folder "./", "/home/vagrant/reignite"
config.vm.synced_folder "./", "/home/vagrant/flintlock"

cpus = 2
memory = 4096
Expand All @@ -35,7 +35,7 @@ Vagrant.configure("2") do |config|
# v.storage_pool_name = "vagrant"
v.cpus = cpus
v.memory = memory
override.vm.synced_folder "./", "/home/vagrant/reignite", type: "nfs"
override.vm.synced_folder "./", "/home/vagrant/flintlock", type: "nfs"
end

config.vm.provision "upgrade-packages", type: "shell", run: "once" do |sh|
Expand Down Expand Up @@ -94,7 +94,7 @@ EOF
mkdir -p /var/lib/containerd-dev/snapshotter/devmapper
mkdir -p /run/containerd-dev/
cp /home/vagrant/reignite/hack/scripts/example-config.toml /etc/containerd/config.toml
cp /home/vagrant/flintlock/hack/scripts/example-config.toml /etc/containerd/config.toml
systemctl restart containerd
SHELL
Expand Down
18 changes: 9 additions & 9 deletions api/services/microvm/v1alpha1/microvms.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 11 additions & 11 deletions api/services/microvm/v1alpha1/microvms.proto
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ import "google/api/annotations.proto";
import "protoc-gen-openapiv2/options/annotations.proto";
import "types/microvm.proto";

option go_package = "github.com/weaveworks/reignite/api/services/microvm/v1alpha1";
option go_package = "github.com/weaveworks/flintlock/api/services/microvm/v1alpha1";

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
info: {
title: "Reignite MicroVM API"
title: "Flintlock MicroVM API"
version: "0.1"
description: "The Reignite MicroVM API handles operations for provisioning and managing microvms"
description: "The Flintlock MicroVM API handles operations for provisioning and managing microvms"
}
consumes: "application/json"
produces: "application/json"
Expand All @@ -36,7 +36,7 @@ service MicroVM {
rpc DeleteMicroVM(DeleteMicroVMRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha1/microvm/{namespace}/{id}"
};
};
}
rpc GetMicroVM(GetMicroVMRequest) returns (GetMicroVMResponse) {
option (google.api.http) = {
Expand All @@ -52,12 +52,12 @@ service MicroVM {
}

message CreateMicroVMRequest {
reignite.types.MicroVMSpec microvm = 1;
flintlock.types.MicroVMSpec microvm = 1;
map<string, google.protobuf.Any> metadata = 2;
}

message CreateMicroVMResponse {
reignite.types.MicroVMSpec microvm = 1;
flintlock.types.MicroVMSpec microvm = 1;
}

message DeleteMicroVMRequest {
Expand All @@ -66,12 +66,12 @@ message DeleteMicroVMRequest {
}

message UpdateMicroVMRequest {
reignite.types.MicroVMSpec microvm = 1;
flintlock.types.MicroVMSpec microvm = 1;
google.protobuf.FieldMask update_mask = 2;
}

message UpdateMicroVMResponse {
reignite.types.MicroVMSpec microvm = 1;
flintlock.types.MicroVMSpec microvm = 1;
}

message GetMicroVMRequest {
Expand All @@ -80,17 +80,17 @@ message GetMicroVMRequest {
}

message GetMicroVMResponse {
reignite.types.MicroVMSpec microvm = 1;
flintlock.types.MicroVMSpec microvm = 1;
}

message ListMicroVMsRequest {
string namespace = 1;
}

message ListMicroVMsResponse {
repeated reignite.types.MicroVMSpec microvm = 1;
repeated flintlock.types.MicroVMSpec microvm = 1;
}

message ListMessage {
reignite.types.MicroVMSpec microvm = 1;
flintlock.types.MicroVMSpec microvm = 1;
}
4 changes: 2 additions & 2 deletions api/services/microvm/v1alpha1/microvms.swagger.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
"title": "Reignite MicroVM API",
"description": "The Reignite MicroVM API handles operations for provisioning and managing microvms",
"title": "Flintlock MicroVM API",
"description": "The Flintlock MicroVM API handles operations for provisioning and managing microvms",
"version": "0.1"
},
"tags": [
Expand Down
Loading

0 comments on commit 3d09bf1

Please sign in to comment.