You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2020/12/11 09:07:53 UTC
[GitHub] [apisix-ingress-controller] tokers opened a new pull request #83: chore: api server module
tokers opened a new pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] gxthrj commented on a change in pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
gxthrj commented on a change in pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#discussion_r540829523
##########
File path: pkg/api/server.go
##########
@@ -0,0 +1,64 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You 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.
+package api
+
+import (
+ "net"
+
+ "github.com/gin-gonic/gin"
+
+ apirouter "github.com/api7/ingress-controller/pkg/api/router"
+ "github.com/api7/ingress-controller/pkg/config"
+ "github.com/api7/ingress-controller/pkg/log"
+ "github.com/api7/ingress-controller/pkg/types"
+)
+
+// Server represents the API Server in ingress-apisix-controller.
+type Server struct {
+ router *gin.Engine
+ httpListener net.Listener
+}
+
+// NewServer initializes the API Server.
+func NewServer(cfg *config.Config) (*Server, error) {
+ httpListener, err := net.Listen("tcp", cfg.HTTPListen)
+ if err != nil {
+ return nil, err
+ }
+ gin.SetMode(gin.ReleaseMode)
+ router := gin.New()
+ router.Use(gin.Recovery(), gin.Logger())
+ apirouter.Mount(router)
+
+ return &Server{
+ router: router,
+ httpListener: httpListener,
+ }, nil
+}
+
+// Run launches the API Server.
+func (srv *Server) Run(stopCh <-chan struct{}) error {
+ go func() {
+ <-stopCh
+ if err := srv.httpListener.Close(); err != nil {
+ log.Errorf("failed to close http listener: %s", err)
+ }
+ }()
+ if err := srv.router.RunListener(srv.httpListener); err != nil && !types.IsUseOfClosedNetConnErr(err) {
Review comment:
should we set some timeout for request?
##########
File path: pkg/api/router/router.go
##########
@@ -0,0 +1,40 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You 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.
+
+package router
+
+import (
+ "net/http"
+
+ "github.com/gin-gonic/gin"
+)
+
+type healthzResponse struct {
+ Status string `json:"status"`
+}
+
+func mountHealthz(r *gin.Engine) {
+ r.GET("/healthz", healthz)
+ r.GET("/apisix/healthz", healthz)
+}
+
+func healthz(c *gin.Context) {
+ c.AbortWithStatusJSON(http.StatusOK, healthzResponse{Status: "ok"})
Review comment:
We had better end with `return`.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tokers commented on a change in pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#discussion_r540850590
##########
File path: pkg/api/router/router.go
##########
@@ -0,0 +1,40 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You 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.
+
+package router
+
+import (
+ "net/http"
+
+ "github.com/gin-gonic/gin"
+)
+
+type healthzResponse struct {
+ Status string `json:"status"`
+}
+
+func mountHealthz(r *gin.Engine) {
+ r.GET("/healthz", healthz)
+ r.GET("/apisix/healthz", healthz)
+}
+
+func healthz(c *gin.Context) {
+ c.AbortWithStatusJSON(http.StatusOK, healthzResponse{Status: "ok"})
Review comment:
Why?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] gxthrj commented on a change in pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
gxthrj commented on a change in pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#discussion_r540994776
##########
File path: pkg/api/router/router.go
##########
@@ -0,0 +1,40 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You 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.
+
+package router
+
+import (
+ "net/http"
+
+ "github.com/gin-gonic/gin"
+)
+
+type healthzResponse struct {
+ Status string `json:"status"`
+}
+
+func mountHealthz(r *gin.Engine) {
+ r.GET("/healthz", healthz)
+ r.GET("/apisix/healthz", healthz)
+}
+
+func healthz(c *gin.Context) {
+ c.AbortWithStatusJSON(http.StatusOK, healthzResponse{Status: "ok"})
Review comment:
`Abort*`methods does not return directly like its semantics.
If there is logic behind abort, it will continue to execute, so it is recommended to add return and explicitly inform that it will not execute further, although `healthz` is only one line of code :)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] gxthrj commented on pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
gxthrj commented on pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#issuecomment-743732751
Need to resolve conflicts
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tokers commented on a change in pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#discussion_r541516872
##########
File path: pkg/api/router/router.go
##########
@@ -0,0 +1,40 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You 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.
+
+package router
+
+import (
+ "net/http"
+
+ "github.com/gin-gonic/gin"
+)
+
+type healthzResponse struct {
+ Status string `json:"status"`
+}
+
+func mountHealthz(r *gin.Engine) {
+ r.GET("/healthz", healthz)
+ r.GET("/apisix/healthz", healthz)
+}
+
+func healthz(c *gin.Context) {
+ c.AbortWithStatusJSON(http.StatusOK, healthzResponse{Status: "ok"})
Review comment:
Added.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tokers commented on a change in pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#discussion_r541516553
##########
File path: pkg/api/router/router.go
##########
@@ -0,0 +1,40 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You 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.
+
+package router
+
+import (
+ "net/http"
+
+ "github.com/gin-gonic/gin"
+)
+
+type healthzResponse struct {
+ Status string `json:"status"`
+}
+
+func mountHealthz(r *gin.Engine) {
+ r.GET("/healthz", healthz)
+ r.GET("/apisix/healthz", healthz)
+}
+
+func healthz(c *gin.Context) {
+ c.AbortWithStatusJSON(http.StatusOK, healthzResponse{Status: "ok"})
Review comment:
OK, i thought what you said is we should add return statement inside a function without return value.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] Firstsawyou commented on pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
Firstsawyou commented on pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#issuecomment-743091437
Need to resolve conflicts.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tokers commented on pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
tokers commented on pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#issuecomment-743116172
> Need to resolve conflicts.
Resolved.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tokers commented on a change in pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#discussion_r540850451
##########
File path: pkg/api/server.go
##########
@@ -0,0 +1,64 @@
+// Licensed to the Apache Software Foundation (ASF) under one or more
+// contributor license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright ownership.
+// The ASF licenses this file to You 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.
+package api
+
+import (
+ "net"
+
+ "github.com/gin-gonic/gin"
+
+ apirouter "github.com/api7/ingress-controller/pkg/api/router"
+ "github.com/api7/ingress-controller/pkg/config"
+ "github.com/api7/ingress-controller/pkg/log"
+ "github.com/api7/ingress-controller/pkg/types"
+)
+
+// Server represents the API Server in ingress-apisix-controller.
+type Server struct {
+ router *gin.Engine
+ httpListener net.Listener
+}
+
+// NewServer initializes the API Server.
+func NewServer(cfg *config.Config) (*Server, error) {
+ httpListener, err := net.Listen("tcp", cfg.HTTPListen)
+ if err != nil {
+ return nil, err
+ }
+ gin.SetMode(gin.ReleaseMode)
+ router := gin.New()
+ router.Use(gin.Recovery(), gin.Logger())
+ apirouter.Mount(router)
+
+ return &Server{
+ router: router,
+ httpListener: httpListener,
+ }, nil
+}
+
+// Run launches the API Server.
+func (srv *Server) Run(stopCh <-chan struct{}) error {
+ go func() {
+ <-stopCh
+ if err := srv.httpListener.Close(); err != nil {
+ log.Errorf("failed to close http listener: %s", err)
+ }
+ }()
+ if err := srv.router.RunListener(srv.httpListener); err != nil && !types.IsUseOfClosedNetConnErr(err) {
Review comment:
Currently only a health probe, we can add timeout when we have more APIs.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tokers merged pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
tokers merged pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix-ingress-controller] tokers commented on pull request #83: chore: api server module
Posted by GitBox <gi...@apache.org>.
tokers commented on pull request #83:
URL: https://github.com/apache/apisix-ingress-controller/pull/83#issuecomment-743959261
> Need to resolve conflicts
Solved.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org