Rename MCS to Console in codebase (#205)

Author: dvaldivia

.dockerignore

@@ -1,6 +1,6 @@
 node_modules/
 dist/
 target/
-mcs
-!mcs/
+console
+!console/
 portal-ui/node_modules/

.github/workflows/go.yml

@@ -33,4 +33,4 @@ jobs:
         run: |
           make verifiers
           make test
-          make mcs
+          make console

.gitignore

@@ -19,8 +19,8 @@ vendor/
 
 # Ignore executables
 target/
-mcs
-!mcs/
+console
+!console/
 
 dist/
 
@@ -31,4 +31,4 @@ public.crt
 # Ignore VsCode files
 .vscode/
 *.code-workspace
-*~
+*~

.goreleaser.yml

@@ -1,6 +1,6 @@
 # This is an example goreleaser.yaml file with some sane defaults.
 # Make sure to check the documentation at http://goreleaser.com
-project_name: mcs
+project_name: console
 
 before:
   hooks:
@@ -18,12 +18,12 @@ builds:
       - arm64
     env:
       - CGO_ENABLED=0
-    main: ./cmd/mcs/
+    main: ./cmd/console/
     flags:
       - -trimpath
       - --tags=kqueue
     ldflags:
-      - -s -w -X github.com/minio/mcs/pkg.ReleaseTag={{.Tag}} -X github.com/minio/mcs/pkg.CommitID={{.FullCommit}} -X github.com/minio/mcs/pkg.Version={{.Version}} -X github.com/minio/mcs/pkg.ShortCommitID={{.ShortCommit}} -X github.com/minio/mcs/pkg.ReleaseTime={{.Date}}
+      - -s -w -X github.com/minio/console/pkg.ReleaseTag={{.Tag}} -X github.com/minio/console/pkg.CommitID={{.FullCommit}} -X github.com/minio/console/pkg.Version={{.Version}} -X github.com/minio/console/pkg.ShortCommitID={{.ShortCommit}} -X github.com/minio/console/pkg.ReleaseTime={{.Date}}
 archives:
   -
     replacements:
@@ -51,7 +51,7 @@ changelog:
 nfpms:
   -
     vendor: MinIO Inc.
-    homepage: https://github.com/minio/mcs
+    homepage: https://github.com/minio/console
     maintainer: MinIO <[email protected]>
     description: MinIO Console Server
     license: GNU Affero General Public License v3.0
@@ -71,5 +71,5 @@ dockers:
     goarch: amd64
     dockerfile: Dockerfile.release
     image_templates:
-      - "minio/mcs:{{ .Tag }}"
-      - "minio/mcs:latest"
+      - "minio/console:{{ .Tag }}"
+      - "minio/console:latest"

CONTRIBUTING.md

@@ -20,7 +20,7 @@ make swagger-gen
 
 This will update all the necessary code.
 
-`./restapi/configure_mcs.go` is a file that contains the handlers to be used by the application, here is the only place where we need to update our code to support the new apis. This file is not affected when running the swagger generator and it is safe to edit.
+`./restapi/configure_console.go` is a file that contains the handlers to be used by the application, here is the only place where we need to update our code to support the new apis. This file is not affected when running the swagger generator and it is safe to edit.
 
 ## Unit Tests
 `./restapi/handlers_test.go` needs to be updated with the proper tests for the new api.
@@ -47,13 +47,13 @@ $ git push origin my-new-feature
 Pull requests can be created via GitHub. Refer to [this document](https://help.github.com/articles/creating-a-pull-request/) for detailed steps on how to create a pull request. After a Pull Request gets peer reviewed and approved, it will be merged.
 
 ## FAQs
-### How does ``mcs`` manages dependencies?
+### How does ``console`` manages dependencies?
 ``MinIO`` uses `go mod` to manage its dependencies.
 - Run `go get foo/bar` in the source folder to add the dependency to `go.mod` file.
 
 To remove a dependency
 - Edit your code and remove the import reference.
 - Run `go mod tidy` in the source folder to remove dependency from `go.mod` file.
 
-### What are the coding guidelines for mcs?
-``mcs`` is fully conformant with Golang style. Refer: [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project. If you observe offending code, please feel free to send a pull request or ping us on [Slack](https://slack.min.io).
+### What are the coding guidelines for console?
+``console`` is fully conformant with Golang style. Refer: [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project. If you observe offending code, please feel free to send a pull request or ping us on [Slack](https://slack.min.io).

DEVELOPMENT.md

@@ -1,4 +1,4 @@
-# LDAP authentication with MCS
+# LDAP authentication with Console
 
 ## Setup
 
@@ -32,13 +32,13 @@ dn: ou=groups,dc=example,dc=org
 objectclass:organizationalunit
 ou: groups
 description: generic groups branch
-# create mcsAdmin group (this already exists on minio and have a policy of s3::*)
-dn: cn=mcsAdmin,ou=groups,dc=example,dc=org
+# create consoleAdmin group (this already exists on minio and have a policy of s3::*)
+dn: cn=consoleAdmin,ou=groups,dc=example,dc=org
 objectClass: top
 objectClass: posixGroup
 gidNumber: 678
 # Assing group to new user
-dn: cn=mcsAdmin,ou=groups,dc=example,dc=org
+dn: cn=consoleAdmin,ou=groups,dc=example,dc=org
 changetype: modify
 add: memberuid
 memberuid: billy
@@ -48,7 +48,7 @@ $ docker cp billy.ldif my-openldap-container:/container/service/slapd/assets/tes
 $ docker exec my-openldap-container ldapadd -x -D "cn=admin,dc=example,dc=org" -w admin -f /container/service/slapd/assets/test/billy.ldif -H ldap://localhost -ZZ
 ```
 
-Query the ldap server to check the user billy was created correctly and got assigned to the mcsAdmin group, you should get a list 
+Query the ldap server to check the user billy was created correctly and got assigned to the consoleAdmin group, you should get a list 
 containing ldap users and groups.
 
 ```
@@ -73,9 +73,9 @@ Re-enter new password:
 Enter LDAP Password:
 ```
 
-### Add the mcsAdmin policy to user billy on MinIO
+### Add the consoleAdmin policy to user billy on MinIO
 ```
-$ cat > mcsAdmin.json << EOF
+$ cat > consoleAdmin.json << EOF
 {
   "Version": "2012-10-17",
   "Statement": [
@@ -99,8 +99,8 @@ $ cat > mcsAdmin.json << EOF
   ]
 }
 EOF
-$ mc admin policy add myminio mcsAdmin mcsAdmin.json
-$ mc admin policy set myminio mcsAdmin user=billy
+$ mc admin policy add myminio consoleAdmin consoleAdmin.json
+$ mc admin policy set myminio consoleAdmin user=billy
 ```
 
 ## Run MinIO
@@ -116,12 +116,12 @@ export MINIO_IDENTITY_LDAP_SERVER_INSECURE=on
 ./minio server ~/Data
 ```
 
-## Run MCS
+## Run Console
 
 ```
-export MCS_ACCESS_KEY=minio
-export MCS_SECRET_KEY=minio123
+export CONSOLE_ACCESS_KEY=minio
+export CONSOLE_SECRET_KEY=minio123
 ...
-export MCS_LDAP_ENABLED=on
-./mcs server
+export CONSOLE_LDAP_ENABLED=on
+./console server
 ```

Dockerfile

@@ -2,25 +2,25 @@ FROM golang:1.13
 
 RUN apt-get update -y && apt-get install -y ca-certificates
 
-ADD go.mod /go/src/github.com/minio/mcs/go.mod
-ADD go.sum /go/src/github.com/minio/mcs/go.sum
-WORKDIR /go/src/github.com/minio/mcs/
+ADD go.mod /go/src/github.com/minio/console/go.mod
+ADD go.sum /go/src/github.com/minio/console/go.sum
+WORKDIR /go/src/github.com/minio/console/
 
 # Get dependencies - will also be cached if we won't change mod/sum
 RUN go mod download
 
-ADD . /go/src/github.com/minio/mcs/
-WORKDIR /go/src/github.com/minio/mcs/
+ADD . /go/src/github.com/minio/console/
+WORKDIR /go/src/github.com/minio/console/
 
 ENV CGO_ENABLED=0
 
-RUN go build -ldflags "-w -s" -a -o mcs ./cmd/mcs
+RUN go build -ldflags "-w -s" -a -o console ./cmd/console
 
 FROM scratch
 MAINTAINER MinIO Development "[email protected]"
 EXPOSE 9090
 
 COPY --from=0 /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
-COPY --from=0 /go/src/github.com/minio/mcs/mcs .
+COPY --from=0 /go/src/github.com/minio/console/console .
 
-CMD ["/mcs"]
+CMD ["/console"]

Dockerfile.release

@@ -1,6 +1,6 @@
 FROM scratch
 MAINTAINER MinIO Development "[email protected]"
 EXPOSE 9090
-COPY mcs /mcs
+COPY console /console
 
-ENTRYPOINT ["/mcs"]
+ENTRYPOINT ["/console"]

Makefile

@@ -3,19 +3,19 @@ GOPATH := $(shell go env GOPATH)
 # Sets the build version based on the output of the following command, if we are building for a tag, that's the build else it uses the current git branch as the build
 BUILD_VERSION:=$(shell git describe --exact-match --tags $(git log -n1 --pretty='%h') 2>/dev/null || git rev-parse --abbrev-ref HEAD 2>/dev/null)
 BUILD_TIME:=$(shell date 2>/dev/null)
-TAG ?= "minio/m3:$(VERSION)-dev"
+TAG ?= "minio/console:$(VERSION)-dev"
 
-default: mcs
+default: console
 
-.PHONY: mcs
-mcs:
-	@echo "Building mcs binary to './mcs'"
-	@(GO111MODULE=on CGO_ENABLED=0 go build -trimpath --tags=kqueue --ldflags "-s -w" -o mcs ./cmd/mcs)
+.PHONY: console
+console:
+	@echo "Building Console binary to './console'"
+	@(GO111MODULE=on CGO_ENABLED=0 go build -trimpath --tags=kqueue --ldflags "-s -w" -o console ./cmd/console)
 
 k8sdev:
 	@docker build -t $(TAG) --build-arg build_version=$(BUILD_VERSION) --build-arg build_time='$(BUILD_TIME)' .
 	@kind load docker-image $(TAG)
-	@echo "Done, now restart your mcs deployment"
+	@echo "Done, now restart your console deployment"
 
 getdeps:
 	@mkdir -p ${GOPATH}/bin
@@ -33,32 +33,32 @@ lint:
 	@GO111MODULE=on ${GOPATH}/bin/golangci-lint cache clean
 	@GO111MODULE=on ${GOPATH}/bin/golangci-lint run --timeout=5m --config ./.golangci.yml
 
-install: mcs
-	@echo "Installing mcs binary to '$(GOPATH)/bin/mcs'"
-	@mkdir -p $(GOPATH)/bin && cp -f $(PWD)/mcs $(GOPATH)/bin/mcs
-	@echo "Installation successful. To learn more, try \"mcs --help\"."
+install: console
+	@echo "Installing console binary to '$(GOPATH)/bin/console'"
+	@mkdir -p $(GOPATH)/bin && cp -f $(PWD)/console $(GOPATH)/bin/console
+	@echo "Installation successful. To learn more, try \"console --help\"."
 
 swagger-gen:
 	@echo "Generating swagger server code from yaml"
 	@rm -rf models
 	@rm -rf restapi/operations
-	@swagger generate server -A mcs --main-package=mcs --exclude-main -P models.Principal -f ./swagger.yml -r NOTICE
+	@swagger generate server -A console --main-package=console --exclude-main -P models.Principal -f ./swagger.yml -r NOTICE
 
 assets:
 	@(cd portal-ui; yarn install; make build-static; cd ..)
 
 test:
-	@(GO111MODULE=on go test -race -v github.com/minio/mcs/restapi/...)
-	@(GO111MODULE=on go test -race -v github.com/minio/mcs/pkg/...)
+	@(GO111MODULE=on go test -race -v github.com/minio/console/restapi/...)
+	@(GO111MODULE=on go test -race -v github.com/minio/console/pkg/...)
 
 coverage:
-	@(GO111MODULE=on go test -v -coverprofile=coverage.out github.com/minio/mcs/restapi/... && go tool cover -html=coverage.out && open coverage.html)
+	@(GO111MODULE=on go test -v -coverprofile=coverage.out github.com/minio/console/restapi/... && go tool cover -html=coverage.out && open coverage.html)
 
 clean:
 	@echo "Cleaning up all the generated files"
 	@find . -name '*.test' | xargs rm -fv
 	@find . -name '*~' | xargs rm -fv
-	@rm -vf mcs
+	@rm -vf console
 
 docker:
 	@docker build -t $(TAG) --build-arg build_version=$(BUILD_VERSION) --build-arg build_time='$(BUILD_TIME)' .

README.md

@@ -9,20 +9,20 @@ A graphical user interface for [MinIO](https://github.com/minio/minio)
 
 ## Setup
 
-All `mcs` needs is a MinIO user with admin privileges and URL pointing to your MinIO deployment.
+All `console` needs is a MinIO user with admin privileges and URL pointing to your MinIO deployment.
 > Note: We don't recommend using MinIO's Operator Credentials
 
-1. Create a user for `mcs` using `mc`. 
+1. Create a user for `console` using `mc`. 
 ```
 $ set +o history
-$ mc admin user add myminio mcs YOURMCSSECRET
+$ mc admin user add myminio console YOURCONSOLESECRET
 $ set -o history
 ```
 
-2. Create a policy for `mcs` with access to everything (for testing and debugging)
+2. Create a policy for `console` with access to everything (for testing and debugging)
 
 ```
-$ cat > mcsAdmin.json << EOF
+$ cat > consoleAdmin.json << EOF
 {
 	"Version": "2012-10-17",
 	"Statement": [{
@@ -45,18 +45,18 @@ $ cat > mcsAdmin.json << EOF
 	]
 }
 EOF
-$ mc admin policy add myminio mcsAdmin mcsAdmin.json
+$ mc admin policy add myminio consoleAdmin consoleAdmin.json
 ```
 
-3. Set the policy for the new `mcs` user
+3. Set the policy for the new `console` user
 
 ```
-$ mc admin policy set myminio mcsAdmin user=mcs
+$ mc admin policy set myminio consoleAdmin user=console
 ```
 
 
 ### Note
-Additionally, you can create policies to limit the privileges for `mcs` users, for example, if you want the user to only have access to dashboard, buckets, notifications and watch page, the policy should look like this:
+Additionally, you can create policies to limit the privileges for `console` users, for example, if you want the user to only have access to dashboard, buckets, notifications and watch page, the policy should look like this:
 ```
 {
 	"Version": "2012-10-17",
@@ -97,34 +97,34 @@ Additionally, you can create policies to limit the privileges for `mcs` users, f
 }
 ```
 
-## Run MCS server
+## Run Console server
 To run the server:
 
 ```
-export MCS_HMAC_JWT_SECRET=YOURJWTSIGNINGSECRET
+export CONSOLE_HMAC_JWT_SECRET=YOURJWTSIGNINGSECRET
 
 #required to encrypt jwet payload
-export MCS_PBKDF_PASSPHRASE=SECRET
+export CONSOLE_PBKDF_PASSPHRASE=SECRET
 
 #required to encrypt jwet payload
-export MCS_PBKDF_SALT=SECRET
+export CONSOLE_PBKDF_SALT=SECRET
 
-export MCS_ACCESS_KEY=mcs
-export MCS_SECRET_KEY=YOURMCSSECRET
-export MCS_MINIO_SERVER=http://localhost:9000
-./mcs server
+export CONSOLE_ACCESS_KEY=console
+export CONSOLE_SECRET_KEY=YOURCONSOLESECRET
+export CONSOLE_MINIO_SERVER=http://localhost:9000
+./console server
 ```
 
-## Connect MCS to a Minio using TLS and a self-signed certificate
+## Connect Console to a Minio using TLS and a self-signed certificate
 
 ```
 ...
-export MCS_MINIO_SERVER_TLS_ROOT_CAS=<certificate_file_name>
-export MCS_MINIO_SERVER=https://localhost:9000
-./mcs server
+export CONSOLE_MINIO_SERVER_TLS_ROOT_CAS=<certificate_file_name>
+export CONSOLE_MINIO_SERVER=https://localhost:9000
+./console server
 ```
 
 You can verify that the apis work by doing the request on `localhost:9090/api/v1/...`
 
-# Contribute to mcs Project
-Please follow mcs [Contributor's Guide](https://github.com/minio/mcs/blob/master/CONTRIBUTING.md)
+# Contribute to console Project
+Please follow console [Contributor's Guide](https://github.com/minio/console/blob/master/CONTRIBUTING.md)

SECURITY.md

@@ -2,12 +2,12 @@
 
 ## Supported Versions
 
-We always provide security updates for the [latest release](https://github.com/minio/mcs/releases/latest).
+We always provide security updates for the [latest release](https://github.com/minio/console/releases/latest).
 Whenever there is a security update you just need to upgrade to the latest version.
 
 ## Reporting a Vulnerability
 
-All security bugs in [minio/mcs](https://github,com/minio/mcs) (or other minio/* repositories)
+All security bugs in [minio/console](https://github,com/minio/console) (or other minio/* repositories)
 should be reported by email to [email protected]. Your email will be acknowledged within 48 hours,
 and you'll receive a more detailed response to your email within 72 hours indicating the next steps
 in handling your report.