diff --git a/build/build-image/Dockerfile b/build/build-image/Dockerfile index 5a90189a21..4f2af869c0 100644 --- a/build/build-image/Dockerfile +++ b/build/build-image/Dockerfile @@ -89,7 +89,7 @@ RUN curl -sL https://deb.nodesource.com/setup_12.x | bash - && \ # install API reference docs generator RUN mkdir -p /go/src/github.com/ahmetb && \ - cd /go/src/github.com/ahmetb && git clone -b v0.1.1 https://github.com/ahmetb/gen-crd-api-reference-docs && \ + cd /go/src/github.com/ahmetb && git clone -b v0.2.0 https://github.com/ahmetb/gen-crd-api-reference-docs && \ cd ./gen-crd-api-reference-docs && go build # html checker diff --git a/site/.gitignore b/site/.gitignore index c718fcf522..720e22f354 100644 --- a/site/.gitignore +++ b/site/.gitignore @@ -4,3 +4,4 @@ resources/ node_modules/ tech-doc-hugo *.json +!/assets/templates/crd-doc-config.json diff --git a/site/assets/templates/crd-doc-config.json b/site/assets/templates/crd-doc-config.json new file mode 100644 index 0000000000..47e25111d5 --- /dev/null +++ b/site/assets/templates/crd-doc-config.json @@ -0,0 +1,28 @@ +{ + "hideMemberFields": [ + "TypeMeta" + ], + "hideTypePatterns": [ + "ParseError$", + "List$" + ], + "externalPackages": [ + { + "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$", + "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration" + }, + { + "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", + "docsURLTemplate": "https://v1-15.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" + }, + { + "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/", + "docsURLTemplate": "https://godoc.org/github.com/knative/pkg/apis/duck/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}" + } + ], + "typeDisplayNamePrefixOverrides": { + "k8s.io/api/": "Kubernetes ", + "k8s.io/apimachinery/pkg/apis/": "Kubernetes " + }, + "markdownDisabled": false +} \ No newline at end of file diff --git a/site/assets/templates/pkg.tpl b/site/assets/templates/pkg.tpl index 90944e39ad..6619fca5e8 100644 --- a/site/assets/templates/pkg.tpl +++ b/site/assets/templates/pkg.tpl @@ -5,21 +5,23 @@ {{ end}} {{ range .packages }} -

+

{{- packageDisplayName . -}}

- {{ with .DocComments }} -

- {{ safe (renderComments .) }} -

+ {{ with (index .GoPackages 0 )}} + {{ with .DocComments }} +

+ {{ safe (renderComments .) }} +

+ {{ end }} {{ end }} Resource Types: @@ -27,7 +29,7 @@ {{- range (visibleTypes (sortedTypes .Types)) -}} {{ if isExportedType . -}}
  • - {{ typeIdentifier . }} + {{ typeDisplayName . }}
    • {{- end }} {{- end -}} diff --git a/site/content/en/docs/Advanced/limiting-resources.md b/site/content/en/docs/Advanced/limiting-resources.md index 80fa827f20..9702626dc5 100644 --- a/site/content/en/docs/Advanced/limiting-resources.md +++ b/site/content/en/docs/Advanced/limiting-resources.md @@ -19,7 +19,7 @@ Kubernetes documentation for more details on "requests" and "limits" to both CPU ## GameServers -Since the `GameServer` specification provides a full [`PodSpecTemplate`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.10/#podtemplatespec-v1-core), +Since the `GameServer` specification provides a full [`PodSpecTemplate`](https://v1-15.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.15/#podtemplatespec-v1-core), we can take advantage of both resource limits and requests in our `GameServer` configurations. For example, to set a CPU limit on our `GameServer` configuration of `250m/0.25` of a CPU, diff --git a/site/content/en/docs/Guides/Client SDKs/_index.md b/site/content/en/docs/Guides/Client SDKs/_index.md index 17f4b97911..a7299d0ab6 100644 --- a/site/content/en/docs/Guides/Client SDKs/_index.md +++ b/site/content/en/docs/Guides/Client SDKs/_index.md @@ -277,7 +277,7 @@ If `GameServer.Status.Players.IDs` is set manually through the Kubernetes API, u or SDK.WatchGameServer() instead to list the connected players. {{< /alert >}} -[playerstatus]: {{< ref "/docs/Reference/agones_crd_api_reference.html#PlayerStatus" >}} +[playerstatus]: {{< ref "/docs/Reference/agones_crd_api_reference.html#agones.dev/v1.PlayerStatus" >}} ## Writing your own SDK diff --git a/site/content/en/docs/Guides/Client SDKs/rest.md b/site/content/en/docs/Guides/Client SDKs/rest.md index e87c8e2bba..e80c8e8b1a 100644 --- a/site/content/en/docs/Guides/Client SDKs/rest.md +++ b/site/content/en/docs/Guides/Client SDKs/rest.md @@ -310,4 +310,4 @@ Response: {"list":["uzh7i","3zh7i"]} ``` -[playerstatus]: {{< ref "/docs/Reference/agones_crd_api_reference.html#PlayerStatus" >}} +[playerstatus]: {{< ref "/docs/Reference/agones_crd_api_reference.html#agones.dev/v1.PlayerStatus" >}} diff --git a/site/content/en/docs/Reference/agones_crd_api_reference.html b/site/content/en/docs/Reference/agones_crd_api_reference.html index df1fce8daa..5584eecd45 100644 --- a/site/content/en/docs/Reference/agones_crd_api_reference.html +++ b/site/content/en/docs/Reference/agones_crd_api_reference.html @@ -65,7 +65,7 @@

    Fleet metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -103,7 +103,7 @@

    Fleet strategy
    - + Kubernetes apps/v1.DeploymentStrategy @@ -191,7 +191,7 @@

    GameServer metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -280,7 +280,7 @@

    GameServer template
    - + Kubernetes core/v1.PodTemplateSpec @@ -356,7 +356,7 @@

    GameServerSet metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -503,7 +503,7 @@

    FleetSpec strategy
    - + Kubernetes apps/v1.DeploymentStrategy @@ -704,7 +704,7 @@

    GameServerPort protocol
    - + Kubernetes core/v1.Protocol @@ -943,7 +943,7 @@

    GameServerSpec template
    - + Kubernetes core/v1.PodTemplateSpec @@ -1043,7 +1043,7 @@

    GameServerStatus reservedUntil
    - + Kubernetes meta/v1.Time @@ -1131,7 +1131,7 @@

    GameServerTemplateSpec metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -1220,7 +1220,7 @@

    GameServerTemplateSpec template
    - + Kubernetes core/v1.PodTemplateSpec @@ -1505,7 +1505,7 @@

    GameServerAllocation metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -1546,7 +1546,7 @@

    GameServerAllocation required
    - + Kubernetes meta/v1.LabelSelector @@ -1559,7 +1559,7 @@

    GameServerAllocation preferred
    - + []Kubernetes meta/v1.LabelSelector @@ -1647,7 +1647,7 @@

    GameServerAllocationSpec required
    - + Kubernetes meta/v1.LabelSelector @@ -1660,7 +1660,7 @@

    GameServerAllocationSpec preferred
    - + []Kubernetes meta/v1.LabelSelector @@ -1851,7 +1851,7 @@

    MultiClusterSetting policySelector
    - + Kubernetes meta/v1.LabelSelector @@ -1904,7 +1904,7 @@

    FleetAutoscaler metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -2349,7 +2349,7 @@

    FleetAutoscalerStatus lastScaleTime
    - + Kubernetes meta/v1.Time @@ -2438,7 +2438,7 @@

    WebhookPolicy service
    - + Kubernetes admissionregistration/v1beta1.ServiceReference @@ -2512,7 +2512,7 @@

    GameServerAllocationPolicy metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -2769,31 +2769,31 @@

    GameServerAllocationPolicySpec

    Packages:

    -

    agones.dev

    +

    agones.dev/v1

    Package v1 is the v1 version of the API.

    Resource Types: -

    Fleet +

    Fleet

    Fleet is the data structure for a Fleet resource

    @@ -2827,7 +2827,7 @@

    Fleet metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -2841,7 +2841,7 @@

    Fleet spec
    - + FleetSpec @@ -2865,7 +2865,7 @@

    Fleet strategy
    - + Kubernetes apps/v1.DeploymentStrategy @@ -2889,7 +2889,7 @@

    Fleet template
    - + GameServerTemplateSpec @@ -2905,7 +2905,7 @@

    Fleet status
    - + FleetStatus @@ -2915,7 +2915,7 @@

    Fleet -

    GameServer +

    GameServer

    GameServer is the data structure for a GameServer resource. @@ -2953,7 +2953,7 @@

    GameServer metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -2967,7 +2967,7 @@

    GameServer spec
    - + GameServerSpec @@ -2992,7 +2992,7 @@

    GameServer ports
    - + []GameServerPort @@ -3005,7 +3005,7 @@

    GameServer health
    - + Health @@ -3029,7 +3029,7 @@

    GameServer sdkServer
    - + SdkServer @@ -3042,7 +3042,7 @@

    GameServer template
    - + Kubernetes core/v1.PodTemplateSpec @@ -3055,7 +3055,7 @@

    GameServer players
    - + PlayersSpec @@ -3072,7 +3072,7 @@

    GameServer status
    - + GameServerStatus @@ -3082,7 +3082,7 @@

    GameServer -

    GameServerSet +

    GameServerSet

    GameServerSet is the data structure for a set of GameServers. @@ -3118,7 +3118,7 @@

    GameServerSet metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -3132,7 +3132,7 @@

    GameServerSet spec
    - + GameServerSetSpec @@ -3167,7 +3167,7 @@

    GameServerSet template
    - + GameServerTemplateSpec @@ -3183,7 +3183,7 @@

    GameServerSet status
    - + GameServerSetStatus @@ -3193,12 +3193,12 @@

    GameServerSet -

    AggregatedPlayerStatus +

    AggregatedPlayerStatus

    (Appears on: -FleetStatus, -GameServerSetStatus) +FleetStatus, +GameServerSetStatus)

    AggregatedPlayerStatus stores total player tracking values

    @@ -3233,11 +3233,11 @@

    AggregatedPlayerStatus -

    FleetSpec +

    FleetSpec

    (Appears on: -Fleet) +Fleet)

    FleetSpec is the spec for a Fleet

    @@ -3265,7 +3265,7 @@

    FleetSpec strategy
    - + Kubernetes apps/v1.DeploymentStrategy @@ -3289,7 +3289,7 @@

    FleetSpec template
    - + GameServerTemplateSpec @@ -3300,12 +3300,12 @@

    FleetSpec -

    FleetStatus +

    FleetStatus

    (Appears on: -Fleet, -FleetAutoscaleRequest) +Fleet, +FleetAutoscaleRequest)

    FleetStatus is the status of a Fleet

    @@ -3367,7 +3367,7 @@

    FleetStatus players
    - + AggregatedPlayerStatus @@ -3381,11 +3381,11 @@

    FleetStatus -

    GameServerPort +

    GameServerPort

    (Appears on: -GameServerSpec) +GameServerSpec)

    GameServerPort defines a set of Ports that @@ -3414,7 +3414,7 @@

    GameServerPort portPolicy
    - + PortPolicy @@ -3466,7 +3466,7 @@

    GameServerPort protocol
    - + Kubernetes core/v1.Protocol @@ -3477,11 +3477,11 @@

    GameServerPort -

    GameServerSetSpec +

    GameServerSetSpec

    (Appears on: -GameServerSet) +GameServerSet)

    GameServerSetSpec the specification for GameServerSet

    @@ -3520,7 +3520,7 @@

    GameServerSetSpec template
    - + GameServerTemplateSpec @@ -3531,11 +3531,11 @@

    GameServerSetSpec -

    GameServerSetStatus +

    GameServerSetStatus

    (Appears on: -GameServerSet) +GameServerSet)

    GameServerSetStatus is the status of a GameServerSet

    @@ -3607,7 +3607,7 @@

    GameServerSetStatus players
    - + AggregatedPlayerStatus @@ -3621,12 +3621,12 @@

    GameServerSetStatus -

    GameServerSpec +

    GameServerSpec

    (Appears on: -GameServer, -GameServerTemplateSpec) +GameServer, +GameServerTemplateSpec)

    GameServerSpec is the spec for a GameServer resource

    @@ -3655,7 +3655,7 @@

    GameServerSpec ports
    - + []GameServerPort @@ -3668,7 +3668,7 @@

    GameServerSpec health
    - + Health @@ -3692,7 +3692,7 @@

    GameServerSpec sdkServer
    - + SdkServer @@ -3705,7 +3705,7 @@

    GameServerSpec template
    - + Kubernetes core/v1.PodTemplateSpec @@ -3718,7 +3718,7 @@

    GameServerSpec players
    - + PlayersSpec @@ -3730,20 +3730,20 @@

    GameServerSpec -

    GameServerState +

    GameServerState (string alias)

    (Appears on: -GameServerStatus) +GameServerStatus)

    GameServerState is the state for the GameServer

    -

    GameServerStatus +

    GameServerStatus

    (Appears on: -GameServer) +GameServer)

    GameServerStatus is the status for a GameServer resource

    @@ -3760,7 +3760,7 @@

    GameServerStatus state
    - + GameServerState @@ -3773,7 +3773,7 @@

    GameServerStatus ports
    - + []GameServerStatusPort @@ -3805,7 +3805,7 @@

    GameServerStatus reservedUntil
    - + Kubernetes meta/v1.Time @@ -3817,7 +3817,7 @@

    GameServerStatus players
    - + PlayerStatus @@ -3830,12 +3830,12 @@

    GameServerStatus -

    GameServerStatusPort +

    GameServerStatusPort

    (Appears on: -GameServerAllocationStatus, -GameServerStatus) +GameServerAllocationStatus, +GameServerStatus)

    GameServerStatusPort shows the port that was allocated to a @@ -3871,12 +3871,12 @@

    GameServerStatusPort -

    GameServerTemplateSpec +

    GameServerTemplateSpec

    (Appears on: -FleetSpec, -GameServerSetSpec) +FleetSpec, +GameServerSetSpec)

    GameServerTemplateSpec is a template for GameServers

    @@ -3893,7 +3893,7 @@

    GameServerTemplateSpec metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -3907,7 +3907,7 @@

    GameServerTemplateSpec spec
    - + GameServerSpec @@ -3932,7 +3932,7 @@

    GameServerTemplateSpec ports
    - + []GameServerPort @@ -3945,7 +3945,7 @@

    GameServerTemplateSpec health
    - + Health @@ -3969,7 +3969,7 @@

    GameServerTemplateSpec sdkServer
    - + SdkServer @@ -3982,7 +3982,7 @@

    GameServerTemplateSpec template
    - + Kubernetes core/v1.PodTemplateSpec @@ -3995,7 +3995,7 @@

    GameServerTemplateSpec players
    - + PlayersSpec @@ -4010,11 +4010,11 @@

    GameServerTemplateSpec -

    Health +

    Health

    (Appears on: -GameServerSpec) +GameServerSpec)

    Health configures health checking on the GameServer

    @@ -4073,11 +4073,11 @@

    Health -

    PlayerStatus +

    PlayerStatus

    (Appears on: -GameServerStatus) +GameServerStatus)

    PlayerStatus stores the current player capacity values

    @@ -4122,11 +4122,11 @@

    PlayerStatus -

    PlayersSpec +

    PlayersSpec

    (Appears on: -GameServerSpec) +GameServerSpec)

    PlayersSpec tracks the initial player capacity

    @@ -4151,20 +4151,20 @@

    PlayersSpec -

    PortPolicy +

    PortPolicy (string alias)

    (Appears on: -GameServerPort) +GameServerPort)

    PortPolicy is the port policy for the GameServer

    -

    SdkServer +

    SdkServer

    (Appears on: -GameServerSpec) +GameServerSpec)

    SdkServer specifies parameters for the Agones SDK Server sidecar container

    @@ -4181,7 +4181,7 @@

    SdkServer logLevel
    - + SdkServerLogLevel @@ -4214,25 +4214,25 @@

    SdkServer -

    SdkServerLogLevel +

    SdkServerLogLevel (string alias)

    (Appears on: -SdkServer) +SdkServer)

    SdkServerLogLevel is the log level for SDK server (sidecar) logs

    -

    allocation.agones.dev

    +

    allocation.agones.dev/v1

    Package v1 is the v1 version of the API.

    Resource Types: -

    GameServerAllocation +

    GameServerAllocation

    GameServerAllocation is the data structure for allocating against a set of @@ -4267,7 +4267,7 @@

    GameServerAllocation metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -4281,7 +4281,7 @@

    GameServerAllocation spec
    - + GameServerAllocationSpec @@ -4294,7 +4294,7 @@

    GameServerAllocation multiClusterSetting
    - + MultiClusterSetting @@ -4308,7 +4308,7 @@

    GameServerAllocation required
    - + Kubernetes meta/v1.LabelSelector @@ -4321,7 +4321,7 @@

    GameServerAllocation preferred
    - + []Kubernetes meta/v1.LabelSelector @@ -4347,7 +4347,7 @@

    GameServerAllocation metadata
    - + MetaPatch @@ -4364,7 +4364,7 @@

    GameServerAllocation status
    - + GameServerAllocationStatus @@ -4374,11 +4374,11 @@

    GameServerAllocation -

    GameServerAllocationSpec +

    GameServerAllocationSpec

    (Appears on: -GameServerAllocation) +GameServerAllocation)

    GameServerAllocationSpec is the spec for a GameServerAllocation

    @@ -4395,7 +4395,7 @@

    GameServerAllocationSpec multiClusterSetting
    - + MultiClusterSetting @@ -4409,7 +4409,7 @@

    GameServerAllocationSpec required
    - + Kubernetes meta/v1.LabelSelector @@ -4422,7 +4422,7 @@

    GameServerAllocationSpec preferred
    - + []Kubernetes meta/v1.LabelSelector @@ -4448,7 +4448,7 @@

    GameServerAllocationSpec metadata
    - + MetaPatch @@ -4460,20 +4460,20 @@

    GameServerAllocationSpec -

    GameServerAllocationState +

    GameServerAllocationState (string alias)

    (Appears on: -GameServerAllocationStatus) +GameServerAllocationStatus)

    GameServerAllocationState is the Allocation state

    -

    GameServerAllocationStatus +

    GameServerAllocationStatus

    (Appears on: -GameServerAllocation) +GameServerAllocation)

    GameServerAllocationStatus is the status for an GameServerAllocation resource

    @@ -4490,7 +4490,7 @@

    GameServerAllocationStatus state
    - + GameServerAllocationState @@ -4513,7 +4513,7 @@

    GameServerAllocationStatus ports
    - + []GameServerStatusPort @@ -4543,11 +4543,11 @@

    GameServerAllocationStatus -

    MetaPatch +

    MetaPatch

    (Appears on: -GameServerAllocationSpec) +GameServerAllocationSpec)

    MetaPatch is the metadata used to patch the GameServer metadata on allocation

    @@ -4582,11 +4582,11 @@

    MetaPatch -

    MultiClusterSetting +

    MultiClusterSetting

    (Appears on: -GameServerAllocationSpec) +GameServerAllocationSpec)

    MultiClusterSetting specifies settings for multi-cluster allocation.

    @@ -4613,7 +4613,7 @@

    MultiClusterSetting policySelector
    - + Kubernetes meta/v1.LabelSelector @@ -4624,15 +4624,15 @@

    MultiClusterSetting
    -

    autoscaling.agones.dev

    +

    autoscaling.agones.dev/v1

    Package v1 is the v1 version of the API.

    Resource Types: -

    FleetAutoscaler +

    FleetAutoscaler

    FleetAutoscaler is the data structure for a FleetAutoscaler resource

    @@ -4666,7 +4666,7 @@

    FleetAutoscaler metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -4680,7 +4680,7 @@

    FleetAutoscaler spec
    - + FleetAutoscalerSpec @@ -4703,7 +4703,7 @@

    FleetAutoscaler policy
    - + FleetAutoscalerPolicy @@ -4719,7 +4719,7 @@

    FleetAutoscaler status
    - + FleetAutoscalerStatus @@ -4729,11 +4729,11 @@

    FleetAutoscaler -

    BufferPolicy +

    BufferPolicy

    (Appears on: -FleetAutoscalerPolicy) +FleetAutoscalerPolicy)

    BufferPolicy controls the desired behavior of the buffer policy.

    @@ -4793,11 +4793,11 @@

    BufferPolicy -

    FleetAutoscaleRequest +

    FleetAutoscaleRequest

    (Appears on: -FleetAutoscaleReview) +FleetAutoscaleReview)

    FleetAutoscaleRequest defines the request to webhook autoscaler endpoint

    @@ -4850,7 +4850,7 @@

    FleetAutoscaleRequest status
    - + FleetStatus @@ -4861,11 +4861,11 @@

    FleetAutoscaleRequest -

    FleetAutoscaleResponse +

    FleetAutoscaleResponse

    (Appears on: -FleetAutoscaleReview) +FleetAutoscaleReview)

    FleetAutoscaleResponse defines the response of webhook autoscaler endpoint

    @@ -4914,7 +4914,7 @@

    FleetAutoscaleResponse -

    FleetAutoscaleReview +

    FleetAutoscaleReview

    FleetAutoscaleReview is passed to the webhook with a populated Request value, @@ -4932,7 +4932,7 @@

    FleetAutoscaleReview request
    - + FleetAutoscaleRequest @@ -4944,7 +4944,7 @@

    FleetAutoscaleReview response
    - + FleetAutoscaleResponse @@ -4954,11 +4954,11 @@

    FleetAutoscaleReview -

    FleetAutoscalerPolicy +

    FleetAutoscalerPolicy

    (Appears on: -FleetAutoscalerSpec) +FleetAutoscalerSpec)

    FleetAutoscalerPolicy describes how to scale a fleet

    @@ -4975,7 +4975,7 @@

    FleetAutoscalerPolicy type
    - + FleetAutoscalerPolicyType @@ -4988,7 +4988,7 @@

    FleetAutoscalerPolicy buffer
    - + BufferPolicy @@ -5002,7 +5002,7 @@

    FleetAutoscalerPolicy webhook
    - + WebhookPolicy @@ -5014,21 +5014,21 @@

    FleetAutoscalerPolicy -

    FleetAutoscalerPolicyType +

    FleetAutoscalerPolicyType (string alias)

    (Appears on: -FleetAutoscalerPolicy) +FleetAutoscalerPolicy)

    FleetAutoscalerPolicyType is the policy for autoscaling for a given Fleet

    -

    FleetAutoscalerSpec +

    FleetAutoscalerSpec

    (Appears on: -FleetAutoscaler) +FleetAutoscaler)

    FleetAutoscalerSpec is the spec for a Fleet Scaler

    @@ -5055,7 +5055,7 @@

    FleetAutoscalerSpec policy
    - + FleetAutoscalerPolicy @@ -5066,11 +5066,11 @@

    FleetAutoscalerSpec -

    FleetAutoscalerStatus +

    FleetAutoscalerStatus

    (Appears on: -FleetAutoscaler) +FleetAutoscaler)

    FleetAutoscalerStatus defines the current status of a FleetAutoscaler

    @@ -5111,7 +5111,7 @@

    FleetAutoscalerStatus lastScaleTime
    - + Kubernetes meta/v1.Time @@ -5146,11 +5146,11 @@

    FleetAutoscalerStatus -

    WebhookPolicy +

    WebhookPolicy

    (Appears on: -FleetAutoscalerPolicy) +FleetAutoscalerPolicy)

    WebhookPolicy controls the desired behavior of the webhook policy. @@ -5200,7 +5200,7 @@

    WebhookPolicy service
    - + Kubernetes admissionregistration/v1beta1.ServiceReference @@ -5228,21 +5228,17 @@

    WebhookPolicy
    -

    multicluster.agones.dev

    +

    multicluster.agones.dev/v1

    Package v1 is the v1 version of the API.

    Resource Types: -

    GameServerAllocationPolicy +

    GameServerAllocationPolicy

    -(Appears on: -ConnectionInfoIterator) -

    -

    GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API

    @@ -5274,7 +5270,7 @@

    GameServerAllocationPolicy

    metadata
    - + Kubernetes meta/v1.ObjectMeta @@ -5288,7 +5284,7 @@

    GameServerAllocationPolicy

    		spec
    - + GameServerAllocationPolicySpec @@ -5321,7 +5317,7 @@

    GameServerAllocationPolicy

    		connectionInfo
    - + ClusterConnectionInfo @@ -5334,11 +5330,11 @@

    GameServerAllocationPolicy

    -

    ClusterConnectionInfo +

    ClusterConnectionInfo

    (Appears on: -GameServerAllocationPolicySpec) +GameServerAllocationPolicySpec)

    ClusterConnectionInfo defines the connection information for a cluster

    @@ -5410,7 +5406,7 @@

    ClusterConnectionInfo -

    ConnectionInfoIterator +

    ConnectionInfoIterator

    ConnectionInfoIterator an iterator on ClusterConnectionInfo

    @@ -5449,9 +5445,7 @@

    ConnectionInfoIterator priorityToCluster
    - map[int32]map[string][]*agones.dev/agones/pkg/apis/multicluster/v1.GameServerAllocationPolicy - @@ -5471,11 +5465,11 @@

    ConnectionInfoIterator -

    GameServerAllocationPolicySpec +

    GameServerAllocationPolicySpec

    (Appears on: -GameServerAllocationPolicy) +GameServerAllocationPolicy)

    GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy

    @@ -5512,7 +5506,7 @@

    GameServerAllocationPolicySpec connectionInfo
    - + ClusterConnectionInfo diff --git a/site/content/en/docs/Tutorials/allocator-service-go.md b/site/content/en/docs/Tutorials/allocator-service-go.md index 9ff873681e..cb04c6f7af 100644 --- a/site/content/en/docs/Tutorials/allocator-service-go.md +++ b/site/content/en/docs/Tutorials/allocator-service-go.md @@ -55,7 +55,7 @@ containers: ### 2. Create Firewall Rules -Let's making some [firewall](https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/) rules that will be used by kubernetes health checks and the ingress which we will create shortly. +Let's making some firewall rules that will be used by kubernetes health checks and the ingress which we will create shortly. First, we will make one for the HTTPS health checks that will be sent to our service by running: ``` diff --git a/site/gen-api-docs.sh b/site/gen-api-docs.sh index 6efb8b530d..44154767a3 100755 --- a/site/gen-api-docs.sh +++ b/site/gen-api-docs.sh @@ -14,6 +14,8 @@ # See the License for the specific language governing permissions and # limitations under the License. +set -ex + export GOPROXY=http://proxy.golang.org echo "using go proxy as a workaround for git.agache.org being down: $GOPROXY" @@ -39,7 +41,7 @@ RESULT="/tmp/agones_crd_api_reference.html" # Version to compare OLD="/tmp/old_docs.html" -./gen-crd-api-reference-docs --config ./example-config.json --api-dir ../../../agones.dev/agones/pkg/apis/ --out-file $RESULT +./gen-crd-api-reference-docs --config ../../../agones.dev/agones/site/assets/templates/crd-doc-config.json --api-dir ../../../agones.dev/agones/pkg/apis/ --out-file $RESULT awk '/\ feature\ publishVersion/{flag=1;next}/\ \/feature/{flag=0}flag' $FILE > $OLD # Get the title lines from +++ till empty string @@ -60,7 +62,7 @@ function sedeasy { } # do we have changes in generated API docs compared to previous version -diff $RESULT $OLD +diff $RESULT $OLD || true if [ $? -gt 0 ] then echo "Output to a file $FILE" diff --git a/site/htmltest.yaml b/site/htmltest.yaml index bdbad128c6..8f398efaa4 100644 --- a/site/htmltest.yaml +++ b/site/htmltest.yaml @@ -16,6 +16,7 @@ TestFilesConcurrently: false IgnoreInternalEmptyHash: true OutputDir: /go/src/agones.dev/agones/site/tmp OutputLogFile: .htmltest.log +CheckExternal: true ExternalTimeout: 60 IgnoreURLs: - http://localhost