Archival & Deprecation Roadmap

[denopink]

This ticket will outline a general roadmap for archiving & deprecating webpa-common. Xmidt libraries depending on webpa-common will tagged in this ticket.

Affected Xmidt Repos

• themis
  • https://github.com/xmidt-org/themis/issues/108
  • https://github.com/xmidt-org/themis/pull/124
• argus
  • https://github.com/xmidt-org/argus/issues/280
• bascule
  • https://github.com/xmidt-org/bascule/pull/163
  • https://github.com/xmidt-org/bascule/issues/149
  • https://github.com/xmidt-org/bascule/issues/148
  • https://github.com/xmidt-org/bascule/issues/103
• sallust
  • https://github.com/xmidt-org/sallust/pull/39
  • https://github.com/xmidt-org/sallust/issues/38
  • https://github.com/xmidt-org/sallust/issues/37
  • https://github.com/xmidt-org/sallust/issues/36
• scytale
  • https://github.com/xmidt-org/scytale/issues/195
  • https://github.com/xmidt-org/scytale/pull/203
    • https://github.com/xmidt-org/scytale/issues/199
    • https://github.com/xmidt-org/scytale/issues/186
    • https://github.com/xmidt-org/scytale/issues/210
• caduceator
  • https://github.com/xmidt-org/caduceator/issues/56
• caduceus
  • https://github.com/xmidt-org/caduceus/issues/347
• talaria
  • https://github.com/xmidt-org/talaria/issues/261
    • https://github.com/xmidt-org/talaria/issues/314
    • https://github.com/xmidt-org/talaria/issues/253
• wrp-go
  • https://github.com/xmidt-org/wrp-go/issues/104
• tr1d1um
  • https://github.com/xmidt-org/tr1d1um/issues/304
  • https://github.com/xmidt-org/tr1d1um/pull/324
    • https://github.com/xmidt-org/tr1d1um/issues/326
• heimdall
  • https://github.com/xmidt-org/heimdall/issues/58
• go-parodus
  • https://github.com/xmidt-org/go-parodus/issues/26
• hecate
  • https://github.com/xmidt-org/hecate/issues/56
• svalinn
  • https://github.com/xmidt-org/svalinn/issues/172
• gungnir
  • https://github.com/xmidt-org/gungnir/issues/146
• codex-db
  • https://github.com/xmidt-org/codex-db/issues/52
• wrp-listener
  • https://github.com/xmidt-org/wrp-listener/issues/65
• kratos
  • https://github.com/xmidt-org/kratos/issues/45
• ancla
  • https://github.com/xmidt-org/ancla/issues/119
• mimisbrunnr
  • https://github.com/xmidt-org/mimisbrunnr/issues/93
• glaukos
  • https://github.com/xmidt-org/glaukos/issues/107
• petasos
  • https://github.com/xmidt-org/petasos/issues/110
• voynicrpyto
  • https://github.com/xmidt-org/voynicrypto/issues/38
• codex-deploy
  • https://github.com/xmidt-org/codex-deploy/issues/127

Archival Order

• [ ] logging* related work, replace with webpa-common/logging & go-kit/log & go-kit/kit/log withhttps://github.com/uber-go/zap
  • bascule
  • https://github.com/xmidt-org/bascule/pull/150
    • https://github.com/xmidt-org/bascule/issues/149
    • https://github.com/xmidt-org/bascule/issues/148
    • https://github.com/xmidt-org/bascule/issues/103
  • scytale
  • https://github.com/xmidt-org/scytale/pull/203
    • https://github.com/xmidt-org/scytale/issues/199
    • https://github.com/xmidt-org/scytale/issues/186

Packages ready to be replaced

• https://github.com/uber-go/fx will replace
  • secure*
  • service*
• https://github.com/uber-go/zap will replace
  • logging*

Where packages are used

• device*
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • kratos
• bascule* REMOVED
• bookkeeping REMOVED
• capacitor REMOVED
• clock REMOVED
• concurrent
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • caduceator
  • heimdall
  • svalinn
  • gungnir
• convey*
  • talaria
• event
  • talaria
• hash REMOVED
• health
  • used internally by device*
• logging* REMOVED & Migrated to sallust
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • caduceator
  • heimdall
  • hecate
  • go-parodus
  • svalinn
  • gungnir
  • codex-db
  • wrp-listener
  • kratos
  • ancla
  • mimisbrunnr
  • voynicrpto
• middleware REMOVED
• secured REMOVED
• resource REMOVED
• semaphore
  • caduceus
  • heimdall
  • svalinn
  • codex-db
  • kratos
  • mimisbrunnr
  • glaukos
• server
  • scytale
  • petasos
  • caduceus
  • caduceator
  • heimdall
  • svalinn
  • gungnir
• service* package can be deleted when things move to uber/fx
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
• tracing*
  • wrp-go
  • used internally by http/fanout
• webhook*
  • scytale
  • hecate
• xhttp*
  • scytale
  • tr1d1um
  • petasos
  • talaria
  • caduceus
  • heimdall
  • mimisbrunnr
• xlistener*
  • used internally by server
• xmetrics replaced with touchstone
  • scytale
  • tr1d1um
  • talaria
  • caduceus
  • caduceator
  • heimdall
  • hecate
  • svalinn
  • gungnir
  • codex-db
  • wrp-listener
  • ancla
• xresolver*
  • talaria
• xviper*
  • used internally by service/servicecfg
• transport REMOVED
• monitor
  • scytale
  • petasos
  • talaria
  • used internally by http* & xresolver & device*

Packages that need to be moved

• bascule* to https://github.com/xmidt-org/bascule

[denopink]

Addressing the deprecation of github.com/xmidt-org/webpa-common/v2/logging/* in affected servers/libs first, updating ticket body with info

[denopink]

as mentioned above, we're going forward with replacing both webpa-common/logging and go-kit/logging with zap

[denopink]

reverting service/consul & service/servicecfg packages back to using gokit log because of gokitzk.NewRegistrar