eos: fix default location for xrdcopy binary (#1467)

cs3org · Feb 10, 2021 · 7a9a5ef · 7a9a5ef
1 parent f57cfe5
commit 7a9a5ef
Show file tree

Hide file tree

Showing 10 changed files with 117 additions and 23 deletions.
diff --git a/changelog/unreleased/xrdcopy-default.md b/changelog/unreleased/xrdcopy-default.md
@@ -0,0 +1,3 @@
+Enhancement: Align default location for xrdcopy binary
+
+https://github.com/cs3org/reva/pull/1467
diff --git a/docs/content/en/docs/config/packages/auth/manager/oidc/_index.md b/docs/content/en/docs/config/packages/auth/manager/oidc/_index.md
@@ -9,42 +9,50 @@ description: >
 # _struct: config_
 
 {{% dir name="insecure" type="bool" default=false %}}
-Whether to skip certificate checks when sending requests. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L50)
+Whether to skip certificate checks when sending requests. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L53)
 {{< highlight toml >}}
 [auth.manager.oidc]
 insecure = false
 {{< /highlight >}}
 {{% /dir %}}
 
 {{% dir name="issuer" type="string" default="" %}}
-The issuer of the OIDC token. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L51)
+The issuer of the OIDC token. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L54)
 {{< highlight toml >}}
 [auth.manager.oidc]
 issuer = ""
 {{< /highlight >}}
 {{% /dir %}}
 
 {{% dir name="id_claim" type="string" default="sub" %}}
-The claim containing the ID of the user. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L52)
+The claim containing the ID of the user. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L55)
 {{< highlight toml >}}
 [auth.manager.oidc]
 id_claim = "sub"
 {{< /highlight >}}
 {{% /dir %}}
 
 {{% dir name="uid_claim" type="string" default="" %}}
-The claim containing the UID of the user. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L53)
+The claim containing the UID of the user. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L56)
 {{< highlight toml >}}
 [auth.manager.oidc]
 uid_claim = ""
 {{< /highlight >}}
 {{% /dir %}}
 
 {{% dir name="gid_claim" type="string" default="" %}}
-The claim containing the GID of the user. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L54)
+The claim containing the GID of the user. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L57)
 {{< highlight toml >}}
 [auth.manager.oidc]
 gid_claim = ""
 {{< /highlight >}}
 {{% /dir %}}
 
+{{% dir name="gatewaysvc" type="string" default="" %}}
+The endpoint at which the GRPC gateway is exposed. [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/auth/manager/oidc/oidc.go#L58)
+{{< highlight toml >}}
+[auth.manager.oidc]
+gatewaysvc = ""
+{{< /highlight >}}
+{{% /dir %}}
+
diff --git a/docs/content/en/docs/config/packages/cbox/group/_index.md b/docs/content/en/docs/config/packages/cbox/group/_index.md
@@ -0,0 +1,7 @@
+---
+title: "group"
+linkTitle: "group"
+weight: 10
+description: >
+  Configuration for the group service
+---
diff --git a/docs/content/en/docs/config/packages/cbox/group/rest/_index.md b/docs/content/en/docs/config/packages/cbox/group/rest/_index.md
@@ -0,0 +1,74 @@
+---
+title: "rest"
+linkTitle: "rest"
+weight: 10
+description: >
+  Configuration for the rest service
+---
+
+# _struct: config_
+
+{{% dir name="redis_address" type="string" default="localhost:6379" %}}
+The address at which the redis server is running [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L69)
+{{< highlight toml >}}
+[cbox.group.rest]
+redis_address = "localhost:6379"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="user_groups_cache_expiration" type="int" default=5 %}}
+The time in minutes for which the members of a group would be cached [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L75)
+{{< highlight toml >}}
+[cbox.group.rest]
+user_groups_cache_expiration = 5
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="id_provider" type="string" default="http://cernbox.cern.ch" %}}
+The OIDC Provider [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L77)
+{{< highlight toml >}}
+[cbox.group.rest]
+id_provider = "http://cernbox.cern.ch"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="api_base_url" type="string" default="https://authorization-service-api-dev.web.cern.ch/api/v1.0" %}}
+Base API Endpoint [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L79)
+{{< highlight toml >}}
+[cbox.group.rest]
+api_base_url = "https://authorization-service-api-dev.web.cern.ch/api/v1.0"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="client_id" type="string" default="-" %}}
+Client ID needed to authenticate [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L81)
+{{< highlight toml >}}
+[cbox.group.rest]
+client_id = "-"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="client_secret" type="string" default="-" %}}
+Client Secret [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L83)
+{{< highlight toml >}}
+[cbox.group.rest]
+client_secret = "-"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="oidc_token_endpoint" type="string" default="https://keycloak-dev.cern.ch/auth/realms/cern/api-access/token" %}}
+Endpoint to generate token to access the API [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L86)
+{{< highlight toml >}}
+[cbox.group.rest]
+oidc_token_endpoint = "https://keycloak-dev.cern.ch/auth/realms/cern/api-access/token"
+{{< /highlight >}}
+{{% /dir %}}
+
+{{% dir name="target_api" type="string" default="authorization-service-api" %}}
+The target application for which token needs to be generated [[Ref]](https://github.com/cs3org/reva/tree/master/pkg/cbox/group/rest/rest.go#L88)
+{{< highlight toml >}}
+[cbox.group.rest]
+target_api = "authorization-service-api"
+{{< /highlight >}}
+{{% /dir %}}
+
diff --git a/go.mod b/go.mod
@@ -44,6 +44,7 @@ require (
 	github.com/studio-b12/gowebdav v0.0.0-20200303150724-9380631c29a1
 	github.com/tus/tusd v1.1.1-0.20200416115059-9deabf9d80c2
 	go.opencensus.io v0.22.6
+	golang.org/x/crypto v0.0.0-20201203163018-be400aefbc4c
 	golang.org/x/net v0.0.0-20201202161906-c7110b5ffcbb
 	golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d
 	golang.org/x/term v0.0.0-20201117132131-f5c789dd3221

diff --git a/pkg/eosclient/eosbinary/eosbinary.go b/pkg/eosclient/eosbinary/eosbinary.go
@@ -102,7 +102,7 @@ type Options struct {
 	EosBinary string
 
 	// Location of the xrdcopy binary.
-	// Default is /usr/bin/xrdcopy.
+	// Default is /opt/eos/xrootd/bin/xrdcopy.
 	XrdcopyBinary string
 
 	// URL of the EOS MGM.
@@ -131,7 +131,7 @@ func (opt *Options) init() {
 	}
 
 	if opt.XrdcopyBinary == "" {
-		opt.XrdcopyBinary = "/usr/bin/xrdcopy"
+		opt.XrdcopyBinary = "/opt/eos/xrootd/bin/xrdcopy"
 	}
 
 	if opt.URL == "" {

diff --git a/pkg/eosclient/eosgrpc/eosgrpc.go b/pkg/eosclient/eosgrpc/eosgrpc.go
@@ -75,7 +75,7 @@ type Options struct {
 	SingleUsername string
 
 	// Location of the xrdcopy binary.
-	// Default is /usr/bin/xrdcopy.
+	// Default is /opt/eos/xrootd/bin/xrdcopy.
 	XrdcopyBinary string
 
 	// URL of the EOS MGM.
@@ -107,7 +107,7 @@ func (opt *Options) init() {
 	}
 
 	if opt.XrdcopyBinary == "" {
-		opt.XrdcopyBinary = "/usr/bin/xrdcopy"
+		opt.XrdcopyBinary = "/opt/eos/xrootd/bin/xrdcopy"
 	}
 
 	if opt.URL == "" {

diff --git a/pkg/storage/fs/ocis/ocis_test.go b/pkg/storage/fs/ocis/ocis_test.go
@@ -23,23 +23,24 @@ package ocis
 import (
 	"context"
 	"fmt"
-	userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
-	provider "github.com/cs3org/go-cs3apis/cs3/storage/provider/v1beta1"
-	"github.com/cs3org/reva/pkg/user"
-	"github.com/stretchr/testify/assert"
 	"io/ioutil"
 	"os"
 	"path"
 	"sync"
 	"testing"
+
+	userpb "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
+	provider "github.com/cs3org/go-cs3apis/cs3/storage/provider/v1beta1"
+	"github.com/cs3org/reva/pkg/user"
+	"github.com/stretchr/testify/assert"
 )
 
 // TestLackAdvisoryLocks demonstrates that access to a file
 // is not mutually exclusive on the oCIS storage.
 var (
 	config = make(map[string]interface{})
-	ctx context.Context
-	f, f1 *os.File
+	ctx    context.Context
+	f, f1  *os.File
 	tmpDir string
 )
 
@@ -76,19 +77,19 @@ func TestMain(m *testing.M) {
 	}
 
 	// do not do this. Prepare f0
-	if err = ioutil.WriteFile(fmt.Sprintf("%s/%s", tmpDir,"f.lol"), []byte("test"), 0644); err != nil {
+	if err = ioutil.WriteFile(fmt.Sprintf("%s/%s", tmpDir, "f.lol"), []byte("test"), 0644); err != nil {
 		panic(err)
 	}
-	f, err = os.Open(fmt.Sprintf("%s/%s", tmpDir,"f.lol"))
+	f, err = os.Open(fmt.Sprintf("%s/%s", tmpDir, "f.lol"))
 	if err != nil {
 		panic(err)
 	}
 
 	// do not do this. Prepare f1
-	if err = ioutil.WriteFile(fmt.Sprintf("%s/%s", tmpDir,"f1.lol"), []byte("another run"), 0644); err != nil {
+	if err = ioutil.WriteFile(fmt.Sprintf("%s/%s", tmpDir, "f1.lol"), []byte("another run"), 0644); err != nil {
 		panic(err)
 	}
-	f1, err = os.Open(fmt.Sprintf("%s/%s", tmpDir,"f1.lol"))
+	f1, err = os.Open(fmt.Sprintf("%s/%s", tmpDir, "f1.lol"))
 	if err != nil {
 		panic(err)
 	}
@@ -155,8 +156,8 @@ func TestParallelMkcol(t *testing.T) {
 		t.Error(err)
 	}
 
-	for i:=0; i< 10; i++ {
-		t.Run("", func (t *testing.T) {
+	for i := 0; i < 10; i++ {
+		t.Run("", func(t *testing.T) {
 			t.Parallel()
 			if err := ofs.CreateDir(ctx, "fightforit"); err != nil {
 				rinfo, err := ofs.GetMD(ctx, &provider.Reference{

diff --git a/pkg/storage/utils/eosfs/config.go b/pkg/storage/utils/eosfs/config.go
@@ -38,7 +38,7 @@ type Config struct {
 	EosBinary string `mapstructure:"eos_binary"`
 
 	// Location of the xrdcopy binary.
-	// Default is /usr/bin/xrdcopy.
+	// Default is /opt/eos/xrootd/bin/xrdcopy.
 	XrdcopyBinary string `mapstructure:"xrdcopy_binary"`
 
 	// URL of the Master EOS MGM.

diff --git a/pkg/storage/utils/eosfs/eosfs.go b/pkg/storage/utils/eosfs/eosfs.go
@@ -86,7 +86,7 @@ func (c *Config) init() {
 	}
 
 	if c.XrdcopyBinary == "" {
-		c.XrdcopyBinary = "/usr/bin/xrdcopy"
+		c.XrdcopyBinary = "/opt/eos/xrootd/bin/xrdcopy"
 	}
 
 	if c.MasterURL == "" {